PyANGKernel.GKController¶

class GKController¶

A device used to group network equipment: signal groups, VMS’s, ramp meter devices and detectors together. The Aimsun Controller contains all the parameters needed to emulate a real world controller through the communication with an external application to provide the control logic.

Synopsis¶

Methods¶

def __init__()
def addDetector()
def addPedestrianWalk()
def addSignalGroup()
def clearDetectors()
def clearPedestrianWalks()
def clearSignalGroups()
def createDetector()
def createPedestrianWalk()
def createSignalGroup()
def getControllerType()
def getDetectors()
def getMeterings()
def getParameters()
def getPedestrianWalks()
def getRelatedNodes()
def getRelatedSections()
def getShowConnections()
def getSignalGroups()
def getState()
def hasExternalControl()
def isEnabled()
def isOCITController()
def removeDetector()
def removePedestrianWalk()
def removeSignalGroup()
def setControllerType()
def setIsEnabled()
def setParameters()
def setShowConnections()
def setState()

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 GKControllerType¶: The different types of controllers that Aimsun Next can emulate are: SCATS, SCATSRMS, UTOPIA, VSPLUS, SICE, Yunex UTC (with SCOOT), ETRA, Indra, TELVENT, TELENT and LISA. Aimsun Next will be able to communicate with any of these traffic control systems or traffic management software

class GKControllerState¶: Controller state: - eNormal: no simulation is running. - eConnected: a simulation is running and the controller is connected. - eDisconnected: a simulation is running and the controller is not connected as the communication has failed.

__init__()¶

addDetector(sg)¶

Parameters:: sg – GKControllerDetector

Adds a detector to this controller. The object is adopted.

addPedestrianWalk(sg)¶

Parameters:: sg – GKControllerPedestrianWalk

Adds a pedestrian walk to this controller. The object is adopted.

addSignalGroup(sg)¶

Parameters:: sg – GKControllerSignalGroup

Adds a signal group to this controller. The object is adopted.

clearDetectors()¶

Removes all detectors from this controller. The objects are deleted.

clearPedestrianWalks()¶

Removes all pedestrian walks from this controller. The objects are deleted.

clearSignalGroups()¶

Removes all signal groups from this controller. The objects are deleted.

createDetector()¶

Return type:: GKControllerDetector

Creates a detector to be add later on in this controller using addDetector

static createParameters(controllerType)¶

Parameters:: controllerType – GKControllerType
Return type:: GKControllerPars

createPedestrianWalk()¶

Return type:: GKControllerPedestrianWalk

Creates a pedestrian walk to be add later on in this controller using addPedestrianWalk

createSignalGroup()¶

Return type:: GKControllerSignalGroup

Creates a signal group to be add later on in this controller using addSignalGroup

getControllerType()¶

Return type:: GKControllerType

Returns the type of this controller among the different types of controllers that Aimsun Next can emulate. Aimsun Next will be able to communicate with any of these traffic control systems or traffic management software

getDetectors()¶

Return type:: .list of GKControllerDetector

List all the detectors in this controller.

getMeterings()¶

Return type:: .list of GKMetering

List all the meterings in this controller.

getParameters()¶

Return type:: GKControllerPars

Gets the controller parameters based on its type. For controllers eSCATS, eSCATSRMS, eSICE, eIndra and eDummy it will return a GKControllerPars object. For controllers eUTOPIA it will return a GKControllerParsUTOPIA object. For controllers eVSPLUS and eZGZPRIO it will return a GKControllerParsVSPLUS object. For controllers eETRA it will return a GKControllerParsETRA object. For controllers eTELVENT it will return a GKControllerParsTelvent object. For controllers eTELENT it will return a GKControllerParsTelent object. For controllers eSCOOT it will return a GKControllerParsTelent object. For controllers eLISAPLUS it will return a GKControllerParsLISAPlus object.

getPedestrianWalks()¶

Return type:: .list of GKControllerPedestrianWalk

List all the pedestrian walk in this controller.

getRelatedNodes()¶

Return type:: .list of GKNode

Returns a list containing all the nodes belonging to the associated signal groups, plus all the nodes which are origin or destination of any of the pedestrian walks associated with the controller.

getRelatedSections()¶

Return type:: .list of GKSection

Returns a list containing all the sections which the detectors associated with the controller it belongs to.

getShowConnections()¶

Return type:: bool

When drawing, show the connections?

getSignalGroups()¶

Return type:: .list of GKControllerSignalGroup

List all the signal groups in this controller.

getState()¶

Return type:: GKControllerState

The controller state. UnknownCommand GKControllerState

hasExternalControl(plan)¶

Parameters:: plan – GKMasterControlPlan
Return type:: bool

Returns true if the controller has an External Control or Actuated defined in any item of the given master control plan.

isEnabled()¶

Return type:: bool

Returns true if the controller is Enabled.

See also

setIsEnabled()

isOCITController()¶

Return type:: bool

static isOCITControllerType(type)¶

Parameters:: type – GKControllerType
Return type:: bool

removeDetector(sg)¶

Parameters:: sg – GKControllerDetector

Removes a detector from this controller. The object is deleted.

removePedestrianWalk(sg)¶

Parameters:: sg – GKControllerPedestrianWalk

Removes a pedestrian walk from this controller. The object is deleted.

removeSignalGroup(sg)¶

Parameters:: sg – GKControllerSignalGroup

Removes a signal group from this controller. The object is deleted.

setControllerType(atype)¶

Parameters:: atype – GKControllerType

Sets the type of this controller among the different types of controllers that Aimsun Next can emulate. Aimsun Next will be able to communicate with any of these traffic control systems or traffic management software

setIsEnabled(aIsEnabled)¶

Parameters:: aIsEnabled – bool

Set if the controller is Enabled.

See also

isEnabled()

setParameters(pars)¶

Parameters:: pars – GKControllerPars

Sets the controller parameters based on its type. Be sure that pars parameter has the correct type as set by setControllerType , that are: For controllers eSCATS, eSCATSRMS, eSICE, eIndra and eDummy a GKControllerPars object. For controllers eUTOPIA a GKControllerParsUTOPIA object. For controllers eVSPLUS and eZGZPRIO a GKControllerParsVSPLUS object. For controllers eETRA a GKControllerParsETRA object. For controllers eTELVENT a GKControllerParsTelvent object. For controllers eTELENT a GKControllerParsTelent object. For controllers eSCOOT a GKControllerParsTelent object. For controllers eLISAPLUS a GKControllerParsLISAPlus object.

The pars object is copied.

setShowConnections(value)¶

Parameters:: value – bool

When drawing, show the connections?

setState(astate)¶

Parameters:: astate – GKControllerState

The controller state. UnknownCommand GKControllerState