Aimsun Next Scripting  22
Public Types | Public Member Functions | List of all members
GKControllerSignalGroup Class Reference

Public Types

enum  GKControllerSignalGroupState {
  eOff , eGreen , eYellow , eRed ,
  eFlashing
}
 

Public Member Functions

 GKControllerSignalGroup ()
 
 GKControllerSignalGroup (const GKControllerSignalGroup &sg)
 
uint getId () const
 
void setId (uint aid)
 
const QString & getName () const
 
void setName (const QString &aname)
 
float getYellowTime () const
 
void setYellowTime (float ayellowTime)
 
uint getSecondary () const
 
void setSecondary (uint agroup)
 
const QList< uint > & getSecondaries () const
 
void setSecondaries (const QList< uint > &agroup)
 
const GKControllerSignalGroupState getInitialState () const
 
void setInitialState (const GKControllerSignalGroupState astate)
 
bool getOverrideRedState () const
 
void setOverrideRedState (bool aOverrideRedState)
 
void addSignal (GKControlPlanSignal *sg)
 
void removeSignal (GKControlPlanSignal *sg)
 
void clearSignals ()
 
const QVector< GKControlPlanSignal * > & getSignals () const
 
bool uses (GKControlPlanSignal *sg) const
 
void signalDeleted (GKControlPlanSignal *sg)
 
void nodeDeleted (GKNode *node)
 

Detailed Description

It contains N signals groups from different junctions.

Member Enumeration Documentation

◆ GKControllerSignalGroupState

Possible initial states of a controller signal group

Enumerator
eOff 
eGreen 
eYellow 
eRed 
eFlashing 

Constructor & Destructor Documentation

◆ GKControllerSignalGroup() [1/2]

GKControllerSignalGroup::GKControllerSignalGroup ( )

◆ GKControllerSignalGroup() [2/2]

GKControllerSignalGroup::GKControllerSignalGroup ( const GKControllerSignalGroup sg)

Member Function Documentation

◆ addSignal()

void GKControllerSignalGroup::addSignal ( GKControlPlanSignal sg)

Adds a signal group to this controller signal group.

◆ clearSignals()

void GKControllerSignalGroup::clearSignals ( )

Removes all the signal groups from this controller signal group.

◆ getId()

uint GKControllerSignalGroup::getId ( ) const

The unique id (in a controller) of this controller signal group.

◆ getInitialState()

const GKControllerSignalGroupState GKControllerSignalGroup::getInitialState ( ) const

Returns the initial state of this signal group (Red by default)

◆ getName()

const QString & GKControllerSignalGroup::getName ( ) const

The name of this controller signal group.

◆ getOverrideRedState()

bool GKControllerSignalGroup::getOverrideRedState ( ) const

Returns true if the signal group will be overriden by the secondary state if it is red and false otherwise (It will only be overriden when state is Off).

◆ getSecondaries()

const QList< uint > & GKControllerSignalGroup::getSecondaries ( ) const

Returns the IDs of the secondary signal group or 0 (if no secondary exists)

◆ getSecondary()

uint GKControllerSignalGroup::getSecondary ( ) const

Returns the if of the secondary signal group or 0 (if no secondary exists)

◆ getSignals()

const QVector< GKControlPlanSignal * > & GKControllerSignalGroup::getSignals ( ) const

Returns all the signal groups in this controller signal group.

◆ getYellowTime()

float GKControllerSignalGroup::getYellowTime ( ) const

◆ nodeDeleted()

void GKControllerSignalGroup::nodeDeleted ( GKNode node)

This Node been deleted: remove any signal group from this node.

◆ removeSignal()

void GKControllerSignalGroup::removeSignal ( GKControlPlanSignal sg)

Removes a signal group from this controller signal group.

◆ setId()

void GKControllerSignalGroup::setId ( uint  aid)

The unique id (in a controller) of this controller signal group.

◆ setInitialState()

void GKControllerSignalGroup::setInitialState ( const GKControllerSignalGroupState  astate)

Sets the initial state of this signal group.

◆ setName()

void GKControllerSignalGroup::setName ( const QString &  aname)

The name of this controller signal group.

◆ setOverrideRedState()

void GKControllerSignalGroup::setOverrideRedState ( bool  aOverrideRedState)

Sets whether the signal group will be overriden by the secondary state if it is red (aOverrideRedState should be true and false otherwise ).

◆ setSecondaries()

void GKControllerSignalGroup::setSecondaries ( const QList< uint > &  agroup)

Sets the secondary signal group for this signal group.

◆ setSecondary()

void GKControllerSignalGroup::setSecondary ( uint  agroup)

Sets the secondary signal group for this signal group.

◆ setYellowTime()

void GKControllerSignalGroup::setYellowTime ( float  ayellowTime)

◆ signalDeleted()

void GKControllerSignalGroup::signalDeleted ( GKControlPlanSignal sg)

This Signal Group in a node has been deleted: remove any reference to it.

◆ uses()

bool GKControllerSignalGroup::uses ( GKControlPlanSignal sg) const

Returns true is this object uses the control plan signal "sg".

© Aimsun SLU
Aimsun ®