GKDetectionPatternEvent Class Reference

Inheritance diagram for GKDetectionPatternEvent:

Public Types
enum	OccupancyMode { eContinous , eIntermittent , eRepeatEachCycle }

Public Member Functions
	GKDetectionPatternEvent ()
virtual bool	isValid () const
void	setModel (GKModel *amodel)
virtual GKDetectionPatternEvent *	clone () const
void	setDetector (GKDetector *det)
GKDetector *	getDetector () const
void	setWhen (const GKTimeDuration &time)
const GKTimeDuration &	getWhen () const
void	setDuration (const GKTimeDuration &time)
const GKTimeDuration &	getDuration () const
virtual void	setVehicle (GKVehicle *veh)
GKVehicle *	getVehicle () const
void	setSpeed (double s)
double	getSpeed () const
void	setLength (double l)
double	getLength () const
virtual void	setPTLine (GKPublicLine *line)
GKPublicLine *	getPTLine () const
void	setOccupancyMode (OccupancyMode which)
OccupancyMode	getOccupancyMode () const

Detailed Description

A detection event that will be used by the simulator to simulate a vehicle passing a detector.

It has:

• the detector to activate (and later on deactivate)
• the activation time (relative to the simulation initial time)
• the duration of the activation
• the vehicle type for the detection

Based on the detection capabilities is possible to specify the data to be detected:

• Speed: Can detect speed
• Length: Can detect density
• Transit Line: Can detect an equipped vehicle

Member Enumeration Documentation

OccupancyMode

enum GKDetectionPatternEvent::OccupancyMode

Enumerator
eContinous
eIntermittent
eRepeatEachCycle

Constructor & Destructor Documentation

GKDetectionPatternEvent()

GKDetectionPatternEvent::GKDetectionPatternEvent

(

)

Member Function Documentation

clone()

virtual GKDetectionPatternEvent * GKDetectionPatternEvent::clone ( ) const

virtual

Reimplemented in OCITDetectionPatternEvent.

getDetector()

GKDetector * GKDetectionPatternEvent::getDetector

(

)

const

Detector to activate/deactivate.

getDuration()

const GKTimeDuration & GKDetectionPatternEvent::getDuration

(

)

const

For how long it is active

getLength()

double GKDetectionPatternEvent::getLength

(

)

const

Length detected.

getOccupancyMode()

OccupancyMode GKDetectionPatternEvent::getOccupancyMode

(

)

const

getPTLine()

GKPublicLine * GKDetectionPatternEvent::getPTLine

(

)

const

Transit Line detected.

getSpeed()

double GKDetectionPatternEvent::getSpeed

(

)

const

Speed detected.

getVehicle()

GKVehicle * GKDetectionPatternEvent::getVehicle

(

)

const

Vehicle type detected.

getWhen()

const GKTimeDuration & GKDetectionPatternEvent::getWhen

(

)

const

When it is activated. Relative time from the simulation initial time.

isValid()

virtual bool GKDetectionPatternEvent::isValid ( ) const

virtual

Reimplemented in OCITDetectionPatternEvent.

setDetector()

void GKDetectionPatternEvent::setDetector

(

GKDetector *

det

)

Detector to activate/deactivate.

setDuration()

void GKDetectionPatternEvent::setDuration

(

const GKTimeDuration &

time

)

For how long it is active

setLength()

void GKDetectionPatternEvent::setLength

(

double

l

)

Length detected.

setModel()

void GKDetectionPatternEvent::setModel

(

GKModel *

amodel

)

Set the model where this event is

setOccupancyMode()

void GKDetectionPatternEvent::setOccupancyMode

(

OccupancyMode

which

)

setPTLine()

virtual void GKDetectionPatternEvent::setPTLine ( GKPublicLine *  line )

virtual

Transit Line detected.

Reimplemented in OCITDetectionPatternEvent.

setSpeed()

void GKDetectionPatternEvent::setSpeed

(

double

s

)

Speed detected.

setVehicle()

virtual void GKDetectionPatternEvent::setVehicle ( GKVehicle *  veh )

virtual

Vehicle type detected. It cannot be left unassigned.

Reimplemented in OCITDetectionPatternEvent.

setWhen()

void GKDetectionPatternEvent::setWhen

(

const GKTimeDuration &

time

)

When it is activated. Relative time from the simulation initial time.