PyANGKernel.GKSimulatorExtension¶

class GKSimulatorExtension¶

An extension to Aimsun Next simulators using the Aimsun Next API.

Synopsis¶

Methods¶

def __init__()
def getDescription()
def getReplication()
def getSimulator()
def setDescription()
def setIsHybrid()
def setParameters()
def setReplication()
def setSimulator()
def setTimes()

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

__init__()¶

executeScenarioChange(arg__1)¶

Parameters:: arg__1 – GKScenarioChange

Performs changes defined in the provided scenario change

forceFinishSimulation()¶

Sets the simulation that is being simulated to finish the simulation.

getDescription()¶

Return type:: GKSimulatorExtensionDescription

Returns the extension description.

getPriority()¶

Return type:: int

getReplication()¶

Return type:: GKReplication

The replication that will be simulated. Set by Aimsun Next.

getSimulator()¶

Return type:: void

The simulator…

interestedInScenarioChanges()¶

Return type:: bool

Returns true if this extensions wants to be called when a new scenario change gets activated.

isAborted()¶

Return type:: bool

Returns true if the extension has generated any critical error that forbides to continue with the simulation and false otherwise

isHybrid(replication)¶

Parameters:: replication – GKReplication
Return type:: bool

Ask if is hybrid extension (uses hybrid simulator)

See also

setIsHybrid()

load()¶

setDescription(desc)¶

Parameters:: desc – GKSimulatorExtensionDescription

Sets the description of this extension. Called automatically by Aimsun Next.

setIsHybrid([isHybrid=true])¶

Parameters:: isHybrid – bool

Sets a flag so that the extension is for hybrid simulation (will use hybrid simulator)

See also

isHybrid()

setParameters(pars)¶

Parameters:: pars – str

Sets the parameters (as a XML string) for this extension in the scenario that will be simulated. Called automatically by Aimsun Next.

setReplication(replication)¶

Parameters:: replication – GKReplication

Sets the replication that will be simulated. Called automatically by Aimsun Next.

setSimulator(simulator)¶

Parameters:: simulator – void

Sets the simulator…

setTimes(_cycle, _initialTime, _transitoryDuration)¶

Parameters:

_cycle – float
_initialTime – float
_transitoryDuration – float

Sets the time information for this simulation. Called automatically by Aimsun Next.

stopScenarioChange(arg__1)¶

Parameters:: arg__1 – GKScenarioChange

Rolls back changes defines in the provided scenario change