GKControlDetector Class Reference

Public Member Functions
	GKControlDetector ()
void	setLocking (const bool alock)
const bool	getLocking () const
void	setCallDelay (float adelay)
const float	getCallDelay () const
void	setCallExtension (const float aextension)
const float	getCallExtension () const
void	setPhaseActivation (bool phActivation)
bool	getPhaseActivation () const
void	setPhaseExtension (bool phExtension)
bool	getPhaseExtension () const
void	setDetector (GKDetector *)
const GKDetector *	getDetector () const

Detailed Description

Information associated with a detector used in an actuated control plan. These detectors are normally installed in some or all of the approaches to the intersection.

Constructor & Destructor Documentation

GKControlDetector()

GKControlDetector::GKControlDetector

(

)

Member Function Documentation

getCallDelay()

const float GKControlDetector::getCallDelay

(

)

const

Gets the amount of time that the detector delays its call following a vehicle actuation.

getCallExtension()

const float GKControlDetector::getCallExtension

(

)

const

Returns the amount of time that the detector extends the call.

getDetector()

const GKDetector * GKControlDetector::getDetector

(

)

const

The physical detector. The object is not adopted as it can be shared by other control detectors in other control plans.

getLocking()

const bool GKControlDetector::getLocking

(

)

const

Returns true if the detector has been defined as locking and false if it has been defined as no-locking. The Locking mode retains the number of vehicle actuations until the appropriate phase receives the green interval. The Non-Locking mode retains calls only while vehicles are in the zone of detection.

getPhaseActivation()

bool GKControlDetector::getPhaseActivation

(

)

const

Returns whether the detector call is used to activate the phase when the phase is not active (true). When it is false and the phase is not active the detector call is not taken into account

getPhaseExtension()

bool GKControlDetector::getPhaseExtension

(

)

const

Returns whether the detector call is used to extend the green time of the phase when the phase is active (true). When it is false and the phase is already active the detector call is not taken into account

setCallDelay()

void GKControlDetector::setCallDelay

(

float

adelay

)

Sets the amount of time that the detector delays its call following a vehicle actuation. This is used in non-locking mode when the desired effect is to produce a signal as if the detector was in a position closer to the stop line.

setCallExtension()

void GKControlDetector::setCallExtension

(

const float

aextension

)

Sets the amount of time that the detector extends the call. This is particularly useful for very short-call detectors. This is used in non-locking mode with those narrow detectors for which the desired effect is to produce a presence signal as if they were longer.

setDetector()

void GKControlDetector::setDetector

(

GKDetector *

)

Sets the physical detector. The object is not adopted as it can be shared by other control detectors in other control plans.

setLocking()

void GKControlDetector::setLocking

(

const bool

alock

)

Sets the detector as locking or non-locking. The Locking mode retains the number of vehicle actuations until the appropriate phase receives the green interval. This detector counts vehicle actuations during the yellow and red time of the phase (to accomplish this, the physical detector (GKDetector) must have been configured with the count capability), for example for extending the minimum initial green time. This is particularly useful when the detectors are located remotely. The Non-Locking mode retains calls only while vehicles are in the zone of detection (The detector must be configured with presence capability). Non-locking mode is typically used with detectors close to the stop line. For volume-density operation, the locked mode must be selected.

setPhaseActivation()

void GKControlDetector::setPhaseActivation

(

bool

phActivation

)

Sets the detector call to be used to activate the phase when the phase is not active (true). If false and the phase is not active the detector call will be ignored. By default it is true

setPhaseExtension()

void GKControlDetector::setPhaseExtension

(

bool

phExtension

)

Sets the detector call to be used to extend the green time of the phase when the phase is active (true). If false and the phase is already active the detector call will not be considered. By default it is true