PyANGKernel.GKVehicle¶
- class GKVehicle¶
Class that defines vehicle characteristics
Synopsis¶
Methods¶
def
__init__()def
addPollutant()def
affectedByMFC()def
clearDoors()def
getCapacity()def
getCategory()def
getGiveWayMax()def
getGiveWayMean()def
getGiveWayMin()def
getGuidanceMax()def
getGuidanceMin()def
getIsPTVehicle()def
getLengthMax()def
getLengthMean()def
getLengthMin()def
getMaxSpeedMax()def
getMaxSpeedMin()def
getPCU()def
getPollutants()def
getStopAndGo()def
getWeightMax()def
getWeightMean()def
getWeightMin()def
getWidthMax()def
getWidthMean()def
getWidthMin()def
isCar()def
isMotorbike()def
isMotorized()def
setArticulated()def
setCapacity()def
setCategory()def
setClearance()def
setGiveWay()def
setGiveWayMax()def
setGiveWayMean()def
setGiveWayMin()def
setGuidance()def
setGuidanceMax()def
setGuidanceMin()def
setIsPTVehicle()def
setLength()def
setLengthMax()def
setLengthMean()def
setLengthMin()def
setMaxSpeed()def
setMaxSpeedMax()def
setMaxSpeedMin()def
setPCU()def
setStopAndGo()def
setValueOfTime()def
setWeight()def
setWeightMax()def
setWeightMean()def
setWeightMin()def
setWidth()def
setWidthMax()def
setWidthMean()def
setWidthMin()
Static functions¶
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 CapacityType¶
- __init__()¶
- addPollutant(aPollutant)¶
- Parameters:
aPollutant –
GKVehiclePollutant
Adds a new pollutant. If a pollutant with the same name exists it is replaced.
- addPollutantForEngineType(aEngineType, aPollutant)¶
- Parameters:
aEngineType –
EngineTypeaPollutant –
GKVehiclePollutant
Adds a new pollutant for a engine type. If a pollutant with the same name exists it is replaced.
- addVehicleClass(aclass)¶
- Parameters:
aclass –
GKVehicleClass
This vehicle will use this vehicle class
Gets if it is affected by acceleration model of MFC
See also
Gets if it is affected by acceleration model of TWOPAS
See also
- checkEngineType(aEngineType)¶
- Parameters:
aEngineType –
EngineType- Return type:
- clearDoors()¶
Deletes all door information
- clearVariableReactionTimes()¶
Discard the variable reaction times info
- clearVariableReactionTimesMeso()¶
Discard the variable reaction times info to be used in the Meso experiment.
Gets the transmission efficiency Dev. Battery Consumption Model
Gets the transmission efficiency Max. Battery Consumption Model
Gets the transmission efficiency Mean. Battery Consumption Model
Gets transmission efficiency Min. Battery Consumption Model
Gets if the model allows Non-Lane Based Movements
Get the maximum capacity of this vehicle in the capacity type defined, either number of passengers or length multiplying factor
Get the maximum capacity in number of passenger units of this vehicle
- getCapacityType()¶
- Return type:
Gets the capacity type of this vehicle
- getCategory()¶
- Return type:
Gets the Vehicle Category
Gets the percentage of the Diesel engine vehicles
Gets the percentage of the Electric engine vehicles
- getEngineTypeFleetMix()¶
- Return type:
.std.mapGK.EngineType,double
- static getEngineTypeFromObsoleteLEM(aFuelTypeInternalName, aIsValid)¶
- Parameters:
aFuelTypeInternalName – str
aIsValid – bool
- Return type:
Gets the initial Energy Level Dev. Fuel & Battery Consumption Model
Gets the initial Energy Level Max. Fuel & Battery Consumption Model
Gets the initial Energy Level Mean. Fuel & Battery Consumption Model
Gets the initial Energy Level Min. Fuel & Battery Consumption Model
Returns whether a vehicle is a Transit vehicle or not
Gets if, when Non-Lane Based Movements are allowed, the vehicle must keep to the Left or Right side
Gets the percentage of the LPG engine vehicles
Gets the percentage of the Petrol engine vehicles
- getPollutants()¶
- Return type:
.std.vectorGKVehiclePollutant
Gets all the pollutants.
- getPollutantsForEngine(aEngineType)¶
- Parameters:
aEngineType –
EngineType- Return type:
.std.vectorGKVehiclePollutant
Gets all the pollutants for an Engine Type.
- getQuartetEmissionUsages()¶
- Return type:
.std.mapGK.EngineType,std.vectorGKVehiclePollutant
Gets the seating capacity of this vehicle in the capacity type defined, either number of passengers or length multiplying factor
Gets the seating capacity in number of passenger units of this vehicle
Transportation mode
- getVariableReactionTimes()¶
- Return type:
.list of GKVehicleReactionTimes
Gets all the variable reaction times.
- getVariableReactionTimesMeso()¶
- Return type:
.list of GKVehicleReactionTimes
Gets all the variable reaction times to be used in the Meso experiment.
- getVehicleClasses()¶
- Return type:
.list of GKVehicleClass
Returns the list of vehicle Classes of this vehicle
- pertainToVehicleClass(aclass)¶
- Parameters:
aclass –
GKVehicleClass- Return type:
This vehicle pertains to a vehicle class?
- removePollutant(aPollutantName)¶
- Parameters:
aPollutantName – str
Removes a pollutant (by name).
- removePollutantForEngineType(aEngineType, aPollutantName)¶
- Parameters:
aEngineType –
EngineTypeaPollutantName – str
Removes a pollutant for a engine type (by name).
- removeVehicleClass(aclass)¶
- Parameters:
aclass –
GKVehicleClass
This vehicle will not use this vehicle class
- renamePollutant(aEngineType, aOldName, aNewName)¶
- Parameters:
aEngineType –
EngineTypeaOldName – str
aNewName – str
Renames a pollutant
- setAccelerationAggressiveness(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setAccelerationAggressivenessDeviation(value)¶
- Parameters:
value – float
- setAccelerationAggressivenessMax(value)¶
- Parameters:
value – float
- setAccelerationAggressivenessMean(value)¶
- Parameters:
value – float
- setAccelerationAggressivenessMin(value)¶
- Parameters:
value – float
- setAccesoriesPowerDev(aAccesoriesPowerDev)¶
- Parameters:
aAccesoriesPowerDev – float
Sets the transmission efficiency Dev. Battery Consumption Model
- setAccesoriesPowerMax(aAccesoriesPowerMax)¶
- Parameters:
aAccesoriesPowerMax – float
Sets transmission efficiency Max. Battery Consumption Model
- setAccesoriesPowerMean(aAccesoriesPowerMean)¶
- Parameters:
aAccesoriesPowerMean – float
Sets the transmission efficiency Mean. Battery Consumption Model
- setAccesoriesPowerMin(aAccesoriesPowerMin)¶
- Parameters:
aAccesoriesPowerMin – float
Sets the transmission efficiency Min. Battery Consumption Model
- setAffectedByMFC(aAffectedByMFC)¶
- Parameters:
aAffectedByMFC – bool
Sets affected by acceleration model of MFC
See also
- setAffectedByTWOPAS(aAffectedByTWOPAS)¶
- Parameters:
aAffectedByTWOPAS – bool
Sets affected by acceleration model of TWOPAS
See also
- setAggressivenessLevelMax(value)¶
- Parameters:
value – float
- setAggressivenessLevelMin(value)¶
- Parameters:
value – float
- setAllowModel2D(allow)¶
- Parameters:
allow – bool
Sets if the model allows Non-Lane Based Movements
- setArticulated(value)¶
- Parameters:
value – bool
Sets the vehicle type as articulated or not
See also
isArticulated()- setCACCConnectedDistanceGain(value)¶
- Parameters:
value – float
- setCACCConnectedSpeedGain(value)¶
- Parameters:
value – float
- setCACCGapThresholdMax(value)¶
- Parameters:
value – float
- setCACCGapThresholdMin(value)¶
- Parameters:
value – float
- setCACCTimeGapLeader(value)¶
- Parameters:
value – float
- setCFAggressiveness(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setCFAggressivenessDeviation(value)¶
- Parameters:
value – float
- setCFAggressivenessMax(value)¶
- Parameters:
value – float
- setCFAggressivenessMean(value)¶
- Parameters:
value – float
- setCFAggressivenessMin(value)¶
- Parameters:
value – float
- setCapacity(value)¶
- Parameters:
value – float
Sets the maximum capacity of this vehicle in the capacity type defined, either number of passengers or length multiplying factor
- setCapacityAsPassengers(value)¶
- Parameters:
value – float
Sets the maximum capacity in number of passenger units of this vehicle
- setCapacityType(iCapacityType)¶
- Parameters:
iCapacityType –
CapacityType
Sets the capacity type of this vehicle
- setCategory(aCategory)¶
- Parameters:
aCategory –
VehicleCategory
Sets the Vehicle Category
- setChangeLaneCooperation(value)¶
- Parameters:
value – bool
- setClearance(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setClearanceDeviation(value)¶
- Parameters:
value – float
- setClearanceMax(value)¶
- Parameters:
value – float
- setClearanceMean(value)¶
- Parameters:
value – float
- setClearanceMin(value)¶
- Parameters:
value – float
- setClearanceThresholdMax(value)¶
- Parameters:
value – float
- setClearanceThresholdMin(value)¶
- Parameters:
value – float
- setCruisingTolerance(value)¶
- Parameters:
value – float
- setDesiredTimeGap(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setDesiredTimeGapDeviation(value)¶
- Parameters:
value – float
- setDesiredTimeGapMax(value)¶
- Parameters:
value – float
- setDesiredTimeGapMean(value)¶
- Parameters:
value – float
- setDesiredTimeGapMin(value)¶
- Parameters:
value – float
- setDieselEnginePercentage(aDieselEnginePercentage)¶
- Parameters:
aDieselEnginePercentage – float
Sets the percentage of the Diesel engine vehicles
- setDistanceGain(value)¶
- Parameters:
value – float
- setElectricEnginePercentage(aElectricEnginePercentage)¶
- Parameters:
aElectricEnginePercentage – float
Sets the percentage of the Electric engine vehicles
- setEnRouteODRoutesPercentage(value)¶
- Parameters:
value – float
- setEnRoutePathAssignmentResultsPercentage(value)¶
- Parameters:
value – float
- setEnRouteRouteChoiceModelsPercentage(value)¶
- Parameters:
value – float
- setEngineTypeFleetMix(aEngineTypeFleetMix)¶
- Parameters:
aEngineTypeFleetMix – .std.mapGK.EngineType,double
- setEquippedVehs(value)¶
- Parameters:
value – float
- setGapCooperation(value)¶
- Parameters:
value – bool
- setGiveWay(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setGiveWayDeviation(value)¶
- Parameters:
value – float
- setGiveWayMax(value)¶
- Parameters:
value – float
- setGiveWayMean(value)¶
- Parameters:
value – float
- setGiveWayMin(value)¶
- Parameters:
value – float
- setGuidance(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setGuidanceDeviation(value)¶
- Parameters:
value – float
- setGuidanceMax(value)¶
- Parameters:
value – float
- setGuidanceMean(value)¶
- Parameters:
value – float
- setGuidanceMin(value)¶
- Parameters:
value – float
- setImprudentLaneChanging(value)¶
- Parameters:
value – bool
- setInitialEnergyLevelDev(aInitialEnergyLevelDev)¶
- Parameters:
aInitialEnergyLevelDev – float
Sets the initial Energy Level Dev. Fuel & Battery Consumption Model
- setInitialEnergyLevelMax(aInitialEnergyLevelMax)¶
- Parameters:
aInitialEnergyLevelMax – float
Sets the initial Energy Level Max. Fuel & Battery Consumption Model
- setInitialEnergyLevelMean(aInitialEnergyLevelMean)¶
- Parameters:
aInitialEnergyLevelMean – float
Sets the initial Energy Level Mean. Fuel & Battery Consumption Model
- setInitialEnergyLevelMin(aInitialEnergyLevelMin)¶
- Parameters:
aInitialEnergyLevelMin – float
Sets the initial Energy Level Min. Fuel & Battery Consumption Model
- setIsPTVehicle(val)¶
- Parameters:
val – bool
Sets whether a vehicle is a Transit vehicle or not
- setKeepFastLane(value)¶
- Parameters:
value – float
- setKeepToTheSide(keepToSide)¶
- Parameters:
keepToSide – bool
Sets if, when Non-Lane Based Movements are allowed, the vehicle must keep to the Left or Right side
- setLPGEnginePercentage(aLPGEnginePercentage)¶
- Parameters:
aLPGEnginePercentage – float
Sets the percentage of the LPG engine vehicles
- setLaneRecoverySpeedThreshold(value)¶
- Parameters:
value – float
- setLateralClearance(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setLateralClearanceDeviation(value)¶
- Parameters:
value – float
- setLateralClearanceMax(value)¶
- Parameters:
value – float
- setLateralClearanceMean(value)¶
- Parameters:
value – float
- setLateralClearanceMin(value)¶
- Parameters:
value – float
- setLength(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setLengthDeviation(value)¶
- Parameters:
value – float
- setLengthMax(value)¶
- Parameters:
value – float
- setLengthMean(value)¶
- Parameters:
value – float
- setLengthMin(value)¶
- Parameters:
value – float
- setLookAheadDistanceFactorMax(value)¶
- Parameters:
value – float
- setLookAheadDistanceFactorMin(value)¶
- Parameters:
value – float
- setMaxAcceleration(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setMaxAccelerationDeviation(value)¶
- Parameters:
value – float
- setMaxAccelerationMax(value)¶
- Parameters:
value – float
- setMaxAccelerationMean(value)¶
- Parameters:
value – float
- setMaxAccelerationMin(value)¶
- Parameters:
value – float
- setMaxDeceleration(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setMaxDecelerationDeviation(value)¶
- Parameters:
value – float
- setMaxDecelerationMax(value)¶
- Parameters:
value – float
- setMaxDecelerationMean(value)¶
- Parameters:
value – float
- setMaxDecelerationMin(value)¶
- Parameters:
value – float
- setMaxLateralSpeed(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setMaxLateralSpeedDeviation(value)¶
- Parameters:
value – float
- setMaxLateralSpeedMax(value)¶
- Parameters:
value – float
- setMaxLateralSpeedMean(value)¶
- Parameters:
value – float
- setMaxLateralSpeedMin(value)¶
- Parameters:
value – float
- setMaxSpeed(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setMaxSpeedDeviation(value)¶
- Parameters:
value – float
- setMaxSpeedMax(value)¶
- Parameters:
value – float
- setMaxSpeedMean(value)¶
- Parameters:
value – float
- setMaxSpeedMin(value)¶
- Parameters:
value – float
- setMinimumHeadway(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setMinimumHeadwayDeviation(value)¶
- Parameters:
value – float
- setMinimumHeadwayMax(value)¶
- Parameters:
value – float
- setMinimumHeadwayMean(value)¶
- Parameters:
value – float
- setMinimumHeadwayMin(value)¶
- Parameters:
value – float
- setNormalDeceleration(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setNormalDecelerationDeviation(value)¶
- Parameters:
value – float
- setNormalDecelerationMax(value)¶
- Parameters:
value – float
- setNormalDecelerationMean(value)¶
- Parameters:
value – float
- setNormalDecelerationMin(value)¶
- Parameters:
value – float
- setODRoutesPercentage(value)¶
- Parameters:
value – float
- setOvertakeSpeed(value)¶
- Parameters:
value – float
- setOvertakingMargin(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setOvertakingMarginDeviation(value)¶
- Parameters:
value – float
- setOvertakingMarginMax(value)¶
- Parameters:
value – float
- setOvertakingMarginMean(value)¶
- Parameters:
value – float
- setOvertakingMarginMin(value)¶
- Parameters:
value – float
- setPCU(value)¶
- Parameters:
value – float
- setPathAssignmentResultsPercentage(value)¶
- Parameters:
value – float
- setPetrolEnginePercentage(aPetrolEnginePercentage)¶
- Parameters:
aPetrolEnginePercentage – float
Sets the percentage of the Petrol engine vehicles
- setProportionEquippedWithACC(value)¶
- Parameters:
value – float
- setProportionEquippedWithCACC(value)¶
- Parameters:
value – float
- setQuartetEmissionUsages(aQuartetEmissionUsages)¶
- Parameters:
aQuartetEmissionUsages – .std.mapGK.EngineType,std.vectorGKVehiclePollutant
- setSafetyMarginFactor(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setSafetyMarginFactorDeviation(value)¶
- Parameters:
value – float
- setSafetyMarginFactorMax(value)¶
- Parameters:
value – float
- setSafetyMarginFactorMean(value)¶
- Parameters:
value – float
- setSafetyMarginFactorMin(value)¶
- Parameters:
value – float
- setSeatingCapacity(value)¶
- Parameters:
value – float
Sets the seating capacity of this vehicle in the capacity type defined, either number of passengers or length multiplying factor
- setSeatingCapacityAsPassengers(value)¶
- Parameters:
value – float
Sets the seating capacity in number of passenger units of this vehicle
- setSensitivityFactor(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setSensitivityFactorDeviation(value)¶
- Parameters:
value – float
- setSensitivityFactorMax(value)¶
- Parameters:
value – float
- setSensitivityFactorMean(value)¶
- Parameters:
value – float
- setSensitivityFactorMin(value)¶
- Parameters:
value – float
- setSpeedAcceptance(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setSpeedAcceptanceDeviation(value)¶
- Parameters:
value – float
- setSpeedAcceptanceMax(value)¶
- Parameters:
value – float
- setSpeedAcceptanceMean(value)¶
- Parameters:
value – float
- setSpeedAcceptanceMin(value)¶
- Parameters:
value – float
- setSpeedGainFollowing(value)¶
- Parameters:
value – float
- setSpeedGainFreeFlow(value)¶
- Parameters:
value – float
- setStopAndGo(value)¶
- Parameters:
value – bool
- setTimeGapFollower(value)¶
- Parameters:
value – float
Transportation mode
- setValueOfTime(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setValueOfTimeDeviation(value)¶
- Parameters:
value – float
- setValueOfTimeMax(value)¶
- Parameters:
value – float
- setValueOfTimeMean(value)¶
- Parameters:
value – float
- setValueOfTimeMin(value)¶
- Parameters:
value – float
- setVariableReactionTimes(times)¶
- Parameters:
times – .list of GKVehicleReactionTimes
Sets the variable reaction times by vehicle type.
- setVariableReactionTimesMeso(times)¶
- Parameters:
times – .list of GKVehicleReactionTimes
Sets the variable reaction times by vehicle type to be used in the Meso experiment.
- setWeight(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setWeightDeviation(value)¶
- Parameters:
value – float
- setWeightFrontArea(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setWeightFrontAreaDeviation(value)¶
- Parameters:
value – float
- setWeightFrontAreaMax(value)¶
- Parameters:
value – float
- setWeightFrontAreaMean(value)¶
- Parameters:
value – float
- setWeightFrontAreaMin(value)¶
- Parameters:
value – float
- setWeightHorsePower(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setWeightHorsePowerDeviation(value)¶
- Parameters:
value – float
- setWeightHorsePowerMax(value)¶
- Parameters:
value – float
- setWeightHorsePowerMean(value)¶
- Parameters:
value – float
- setWeightHorsePowerMin(value)¶
- Parameters:
value – float
- setWeightMax(value)¶
- Parameters:
value – float
- setWeightMean(value)¶
- Parameters:
value – float
- setWeightMin(value)¶
- Parameters:
value – float
- setWidth(min, max, mean[, deviation=0.0])¶
- Parameters:
min – float
max – float
mean – float
deviation – float
- setWidthDeviation(value)¶
- Parameters:
value – float
- setWidthMax(value)¶
- Parameters:
value – float
- setWidthMean(value)¶
- Parameters:
value – float
- setWidthMin(value)¶
- Parameters:
value – float