PyANGKernel.GKUserClass¶

class GKUserClass¶

Synopsis¶

Methods¶

def __init__()
def getDistanceWeight()
def getPCUs()
def getPurpose()
def getTravelTimeWeight()
def getUserClassVehicleOccupancy()
def getUserClassVoTDispersion()
def getUserClassVoTMax()
def getUserClassVoTMean()
def getUserClassVoTMedian()
def getUserClassVoTMin()
def getUserClassVoTStDev()
def getVehicle()
def isAutonamed()
def isVoTDefined()
def setAutonamed()
def setDistanceWeight()
def setPurpose()
def setTravelTimeWeight()
def setUserClassVehicleOccupancy()
def setUserClassVoTDispersion()
def setUserClassVoTMax()
def setUserClassVoTMedian()
def setUserClassVoTMin()
def setVehicle()

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¶

This class is used to relate a vehicle type and a purpose in a concept called user-class.

__init__()¶

static createUserClass(model, _vehicle, _purpose)¶

Parameters:

model – GKModel
_vehicle – GKMobileAgent
_purpose – GKTripPurpose

Return type:

GKUserClass

Returns an existing user class, or create a new one, in the given model

static findUserClass(model, _vehicle, _purpose)¶

Parameters:

model – GKModel
_vehicle – GKMobileAgent
_purpose – GKTripPurpose

Return type:

GKUserClass

Returns an existing user class, or NULL, in the given model

getDistanceWeight()¶

Return type:: float

getPCUs()¶

Return type:: float

Gets the PCUs of the user class. The user class PCUs are the same from the vehicle type contained in the user class.

getPurpose()¶

Return type:: GKTripPurpose

Gets the purpose of the user class

getTravelTimeWeight()¶

Return type:: float

getUserClassVehicleOccupancy()¶

Return type:: float

getUserClassVoTDispersion()¶

Return type:: float

Get the user class Value of Time Dispersion.

getUserClassVoTMax()¶

Return type:: float

Get the user class Value of Time Maximum.

getUserClassVoTMean()¶

Return type:: float

Get the user class Value of Time Mean.

getUserClassVoTMedian()¶

Return type:: float

Get the user class Value of Time Median.

getUserClassVoTMin()¶

Return type:: float

Get the user class Value of Time Minimum.

getUserClassVoTStDev()¶

Return type:: float

Get the user class Value of Time Standard Deviation.

getVehicle()¶

Return type:: GKMobileAgent

Gets the vehicle type or pedestrian type of the user class

isAutonamed()¶

Return type:: bool

Returns true if the user class is autonamed.

isVoTDefined()¶

Return type:: bool

Returns true if the Value of Time is defined for this User Class.

setAutonamed(autonamed)¶

Parameters:: autonamed – bool

If the user class is autonamed (true by default), its name * is automatically computed from its purpose and vehicle.

See also

isAutonamed()

setDistanceWeight(value)¶

Parameters:: value – float

setPurpose(_purpose)¶

Parameters:: _purpose – GKTripPurpose

Sets the purpose of the user class

setTravelTimeWeight(value)¶

Parameters:: value – float

setUserClassVehicleOccupancy(value)¶

Parameters:: value – float

setUserClassVoTDispersion(value)¶

Parameters:: value – float

Set the user class Value of Time Dispersion.

setUserClassVoTMax(value)¶

Parameters:: value – float

Set the user class Value of Time Maximum.

setUserClassVoTMedian(value)¶

Parameters:: value – float

Set the user class Value of Time Median.

setUserClassVoTMin(value)¶

Parameters:: value – float

Set the user class Value of Time Minimum.

setVehicle(_vehicle)¶

Parameters:: _vehicle – GKMobileAgent

Sets the vehicle type or pedestrian type of the user class