PyANGKernel.GKPolicy¶

class GKPolicy¶

Inherited by: GKTrafficCondition

Synopsis¶

Methods¶

def __init__()
def addChange()
def applyToWarmUp()
def getAuthority()
def getChanges()
def getStrategy()
def isActiveAt()
def removeChange()
def setApplyToWarmUp()
def setAuthority()
def setStrategy()
def willBeStarted()
def willBeStoped()

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

Detailed Description¶

A collection of traffic management actions that are applied at the same time (usually because they are part of a single conceptual action).

__init__()¶

addChange(change)¶

Parameters:: change – GKScenarioChange

Add a traffic management action. The pointer is adopted.

applyToWarmUp()¶

Return type:: bool

getAuthority()¶

Return type:: GKAuthority

An optional authority that must authorize this policy.

getChanges()¶

Return type:: GKFolder

The list of actions.

getPeriodicCallTimes(aSimInitialTime, aSimDurationTime, aWarmUpPeriod)¶

Parameters:

aSimInitialTime – float
aSimDurationTime – float
aWarmUpPeriod – float

Return type:

.std.pairdouble,double

getPeriodicIncidentTimes(aSimInitialTime, aSimDurationTime, aWarmUpPeriod)¶

Parameters:

aSimInitialTime – float
aSimDurationTime – float
aWarmUpPeriod – float

Return type:

.std.pairdouble,double

getStrategy()¶

Return type:: GKStrategy

The strategy where this policy is. Set by the strategy.

isActiveAt(timeFilter)¶

Parameters:: timeFilter – QTime
Return type:: bool

Returns true if the policy is active at the given time.

removeChange(change)¶

Parameters:: change – GKScenarioChange

Removes a traffic management action. The pointer is not deleted.

setApplyToWarmUp(apply)¶

Parameters:: apply – bool

setAuthority(aauthority)¶

Parameters:: aauthority – GKAuthority

An optional authority that must authorize this policy.

setStrategy(astrategy)¶

Parameters:: astrategy – GKStrategy

The strategy where this policy is. Set by the strategy.

willBeStarted(where)¶

Parameters:: where – GKExperiment
Return type:: bool

willBeStoped(where)¶

Parameters:: where – GKExperiment
Return type:: bool