PyANGKernel.GKControllerSignalGroup¶

class GKControllerSignalGroup¶

A signal group in a controller.

Details

It contains N signals groups from different junctions.

Synopsis¶

Methods¶

def __init__()
def addSignal()
def clearSignals()
def getId()
def getInitialState()
def getName()
def getOverrideRedState()
def getSecondaries()
def getSignals()
def getYellowTime()
def nodeDeleted()
def removeSignal()
def setId()
def setInitialState()
def setName()
def setOverrideRedState()
def setSecondaries()
def setYellowTime()
def signalDeleted()
def uses()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

class GKControllerSignalGroupState¶: Possible initial states of a controller signal group

__init__()¶

__init__(sg)

Parameters:: sg – GKControllerSignalGroup

addSignal(sg)¶

Parameters:: sg – GKControlPlanSignal

Adds a signal group to this controller signal group

clearSignals()¶

Removes all the signal groups from this controller signal group

getId()¶

Return type:: int

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

getInitialState()¶

Return type:: GKControllerSignalGroupState

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

getName()¶

Return type:: str

The name of this controller signal group

getOverrideRedState()¶

Return type:: bool

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()¶

Return type:: .list of uint

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

getSignals()¶

Return type:: .list of GKControlPlanSignal

Returns all the signal groups in this controller signal group

getYellowTime()¶

Return type:: float

nodeDeleted(node)¶

Parameters:: node – GKNode

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

removeSignal(sg)¶

Parameters:: sg – GKControlPlanSignal

Removes a signal group from this controller signal group

setId(aid)¶

Parameters:: aid – int

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

setInitialState(astate)¶

Parameters:: astate – GKControllerSignalGroupState

Sets the initial state of this signal group

setName(aname)¶

Parameters:: aname – str

The name of this controller signal group

setOverrideRedState(aOverrideRedState)¶

Parameters:: aOverrideRedState – bool

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

setSecondaries(agroup)¶

Parameters:: agroup – .list of uint

Sets the secondary signal group for this signal group.

setYellowTime(ayellowTime)¶

Parameters:: ayellowTime – float

signalDeleted(sg)¶

Parameters:: sg – GKControlPlanSignal

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

uses(sg)¶

Parameters:: sg – GKControlPlanSignal
Return type:: bool

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