OCITDetectionPatternEvent Class Reference

Inheritance diagram for OCITDetectionPatternEvent:

Public Member Functions
	OCITDetectionPatternEvent ()
bool	isValid () const
GKDetectionPatternEvent *	clone () const
void	setPTLine (GKPublicLine *line)
void	setVehicle (GKVehicle *veh)
void	setFrom (int cycle, double secondInCycle)
MethodCode OCITTime	time (a0, a1)
sipCpp	setFrom (time)
End QPair< int, double >	getFrom () const
End void	setTo (int cycle, double secondInCycle)
MethodCode OCITTime	time (a0, a1)
sipCpp	setTo (time)
End QPair< int, double >	getTo () const
End uint	getTripNumber () const
void	setTripNumber (uint value)
uint	getPriority () const
void	setPriority (uint value)
short	getTimetableDeviation () const
void	setTimetableDeviation (short value)
uint	getLineNumber () const
void	setLineNumber (uint value)
uint	getRouteNumber () const
void	setRouteNumber (uint value)
uint	getTrainLength () const
void	setTrainLength (uint value)
uint	getManualDirection () const
void	setManualDirection (uint value)
Public Member Functions inherited from GKDetectionPatternEvent
	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

Public Attributes
MethodCode const OCITTime &	time = sipCpp->getFrom()
QPair< int, double > *	from = new QPair<int, double>()
from	first = time.getCycle()
from	second = time.getSecond()
	sipRes = from
QPair< int, double > *	to = new QPair<int, double>()
to	first = time.getCycle()
to	second = time.getSecond()

Additional Inherited Members
Public Types inherited from GKDetectionPatternEvent
enum	OccupancyMode { eContinous , eIntermittent , eRepeatEachCycle }

Detailed Description

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

The correct way to set an activation time is to use the function:

void setFrom( int cycle, double secondInCycle );

The correct way to set a deactivation time is to use the function:

void setTo( int cycle, double secondInCycle );

Calling either

void setWhen( const GKTimeDuration & time ); 

or

void setDuration( const GKTimeDuration & time );

will result in undefined behavior

Constructor & Destructor Documentation

OCITDetectionPatternEvent()

OCITDetectionPatternEvent::OCITDetectionPatternEvent

(

)

Member Function Documentation

clone()

GKDetectionPatternEvent * OCITDetectionPatternEvent::clone ( ) const

virtual

Reimplemented from GKDetectionPatternEvent.

getFrom()

End QPair< int, double > OCITDetectionPatternEvent::getFrom

(

)

const

Retrieves the time at which this event will start as a pair [cycle, second]

getLineNumber()

uint OCITDetectionPatternEvent::getLineNumber

(

)

const

getManualDirection()

uint OCITDetectionPatternEvent::getManualDirection

(

)

const

getPriority()

uint OCITDetectionPatternEvent::getPriority

(

)

const

getRouteNumber()

uint OCITDetectionPatternEvent::getRouteNumber

(

)

const

getTimetableDeviation()

short OCITDetectionPatternEvent::getTimetableDeviation

(

)

const

Deviation from schedule in seconds

getTo()

End QPair< int, double > OCITDetectionPatternEvent::getTo

(

)

const

Retrieves the time at which this event will end as a pair [cycle, second]

getTrainLength()

uint OCITDetectionPatternEvent::getTrainLength

(

)

const

getTripNumber()

End uint OCITDetectionPatternEvent::getTripNumber

(

)

const

isValid()

bool OCITDetectionPatternEvent::isValid ( ) const

virtual

Reimplemented from GKDetectionPatternEvent.

setFrom() [1/2]

void OCITDetectionPatternEvent::setFrom	(	int	cycle,
		double	secondInCycle
	)

Sets the time at which this event will start cycle must be between 1 and 9999 secondInCycle must be between 0.0 and 9999.99

setFrom() [2/2]

sipCpp OCITDetectionPatternEvent::setFrom

(

time

)

setLineNumber()

void OCITDetectionPatternEvent::setLineNumber

(

uint

value

)

setManualDirection()

void OCITDetectionPatternEvent::setManualDirection

(

uint

value

)

setPriority()

void OCITDetectionPatternEvent::setPriority

(

uint

value

)

setPTLine()

void OCITDetectionPatternEvent::setPTLine ( GKPublicLine *  line )

virtual

Transit Line detected.

Reimplemented from GKDetectionPatternEvent.

setRouteNumber()

void OCITDetectionPatternEvent::setRouteNumber

(

uint

value

)

setTimetableDeviation()

void OCITDetectionPatternEvent::setTimetableDeviation

(

short

value

)

setTo() [1/2]

End void OCITDetectionPatternEvent::setTo	(	int	cycle,
		double	secondInCycle
	)

Sets the time at which this event will end cycle must be between 1 and 9999 secondInCycle must be between 0.0 and 9999.99

setTo() [2/2]

sipCpp OCITDetectionPatternEvent::setTo

(

time

)

setTrainLength()

void OCITDetectionPatternEvent::setTrainLength

(

uint

value

)

setTripNumber()

void OCITDetectionPatternEvent::setTripNumber

(

uint

value

)

setVehicle()

void OCITDetectionPatternEvent::setVehicle ( GKVehicle *  veh )

virtual

Vehicle type detected. It cannot be left unassigned.

Reimplemented from GKDetectionPatternEvent.

time() [1/2]

MethodCode OCITTime OCITDetectionPatternEvent::time	(	a0	,
		a1
	)

time() [2/2]

MethodCode OCITTime OCITDetectionPatternEvent::time	(	a0	,
		a1
	)

Member Data Documentation

first [1/2]

from OCITDetectionPatternEvent::first = time.getCycle()

first [2/2]

to OCITDetectionPatternEvent::first = time.getCycle()

from

QPair<int, double>* OCITDetectionPatternEvent::from = new QPair<int, double>()

second [1/2]

from OCITDetectionPatternEvent::second = time.getSecond()

second [2/2]

to OCITDetectionPatternEvent::second = time.getSecond()

sipRes

OCITDetectionPatternEvent::sipRes = from

time

MethodCode const OCITTime & OCITDetectionPatternEvent::time = sipCpp->getFrom()

to

QPair<int, double>* OCITDetectionPatternEvent::to = new QPair<int, double>()