DTAVehicleType Class Reference

Inheritance diagram for DTAVehicleType:

Classes
class	DTAVehicleAttribute

Public Member Functions
	DTAVehicleType ()
int	getModalId () const
double	getMaxSpeedMean () const
double	getMaxSpeedMeanInKmH () const
double	getSpeedAcceptanceMean () const
double	getLengthMean () const
double	getWidthMean () const
double	getMaxAccelMean () const
double	getNormalDecelMean () const
double	getMaxDecelMean () const
double	getGiveWayMean () const
double	getValueOfTimeMean () const
const DTAVehicleAttribute &	getValueOfTime () const
double	getGuidanceMean () const
double	getEquippedVehs () const
double	getCruisingTolerance () const
double	getProbKeepFastLane () const
double	getMaxCapacity () const
uint	getNbOfPollutants () const
bool	isValidQuartetEmissionData () const
bool	isValidFuelConsumptionData () const
uint	getNumberOut () const
uint	getNumberIn () const
uint	getNumberWaiting ()
uint	getNumberLostIn () const
uint	getNumberLostOut () const
QString	printNumberVehicles ()
double	getODRoutesPercentage () const
double	getPathAssignmentResultsPercentage () const
double	getEnrouteRouteChoice () const
double	getEnrouteODRoutes () const
double	getEnroutePathAssignment () const
double	getReactionTimeMeso (double value01) const
double	getReactionTimeMicro (double value01) const
double	getReactionTimeAtStopMeso (double value01) const
double	getReactionTimeAtStopMicro (double value01) const
int	getMaxPathAlternatives () const
void	setMaxPathAlterntives (int value)
double	checkVehType (char *text)
const DTAVehicleAttribute &	getInitialEnergyLevel () const
const DTAVehicleAttribute &	getElectricAccesoriesPowerLevel () const
Public Member Functions inherited from GKSimulatedObject
	GKSimulatedObject ()
	GKSimulatedObject (const GKObject *master, GKModelConnection *connection=NULL)
virtual QString	getTypeExternalName () const
void	setMaster (GKObject *master)
const GKObject *	getMaster () const
virtual quint32	getId () const
virtual const QString &	getName () const
virtual const QString &	getExternalId () const
virtual const QString &	getDescription () const
virtual GKModel *	getModel () const
virtual GKType *	getType () const
virtual bool	isA (const GKType *atype) const
virtual bool	isA (const QString &typeName) const
virtual QVariant *	getDataValue (const GKColumn *attr, bool *deleteit, const GKContext &context=GKContext::anyContext) const
virtual QVariant *	getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const
virtual double	getDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double *deviation=NULL) const
virtual double	getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const
virtual GKTimeSerie *	getDataValueTS (const GKColumn *attr) const
virtual GKTimeSerie *	getDataValueTSByID (uint attrId) const
virtual int	getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
virtual int	getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const
virtual double	getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
virtual double	getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const
virtual QString	getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
virtual QString	getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const
virtual bool	getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
virtual bool	getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const
virtual GKObject *	getDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
virtual GKObject *	getDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const
virtual QDate	getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
virtual QDate	getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const
virtual QTime	getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
virtual QTime	getDataValueTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const
QDateTime	getDataValueDateTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
QDateTime	getDataValueDateTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const
virtual GKTimeDuration	getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
virtual GKTimeDuration	getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const
Public Member Functions inherited from GKBaseObject
	GKBaseObject ()
	if (base)
virtual uint	getId () const =0
virtual const QString &	getTypeName () const =0
virtual QString	getTypeExternalName () const =0
virtual const GKObject *	getMaster () const =0
virtual const QString &	getName () const =0
virtual const QString &	getExternalId () const =0
virtual const QString &	getDescription () const =0
virtual GKModel *	getModel () const =0
virtual QVariant *	getDataValue (const GKColumn *attr, bool *deleteit, const GKContext &context=GKContext::anyContext) const =0
virtual QVariant *	getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const =0
virtual double	getDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double *deviation=NULL) const =0
virtual double	getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const =0
virtual GKTimeSerie *	getDataValueTS (const GKColumn *attr) const =0
virtual GKTimeSerie *	getDataValueTSByID (uint attrId) const =0
virtual int	getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual int	getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual double	getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual double	getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual QString	getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual QString	getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual bool	getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual bool	getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual GKObject *	getDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual GKObject *	getDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual QDate	getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual QDate	getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual QTime	getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual QTime	getDataValueTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual QDateTime	getDataValueDateTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual QDateTime	getDataValueDateTimeByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0
virtual GKTimeDuration	getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
virtual GKTimeDuration	getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const =0

Additional Inherited Members
Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObject *	base = (GKBaseObject*)sipCpp
	sipType = 0
Static Public Attributes inherited from GKBaseObject
Py_END_ALLOW_THREADS static End uint	idAtt
static uint	nameAtt
static uint	externalIdAtt
static uint	descriptionAtt

Constructor & Destructor Documentation

DTAVehicleType()

DTAVehicleType::DTAVehicleType

(

)

Member Function Documentation

checkVehType()

double DTAVehicleType::checkVehType

(

char *

text

)

Returns true if the name of this vehicle type is equal to text.

getCruisingTolerance()

double DTAVehicleType::getCruisingTolerance

(

)

const

Returns the cruising tolerance for fuel consumption & for QUARTET pollution.

getElectricAccesoriesPowerLevel()

const DTAVehicleAttribute & DTAVehicleType::getElectricAccesoriesPowerLevel

(

)

const

Return electric accesories power.

getEnrouteODRoutes()

double DTAVehicleType::getEnrouteODRoutes

(

)

const

Returns the percentage for en-route path update with OD routes.

getEnroutePathAssignment()

double DTAVehicleType::getEnroutePathAssignment

(

)

const

Returns the percentage for en-route path update with path assignment result file.

getEnrouteRouteChoice()

double DTAVehicleType::getEnrouteRouteChoice

(

)

const

Returns the percentage for en-route path update with route choice.

getEquippedVehs()

double DTAVehicleType::getEquippedVehs

(

)

const

Returns percentage of equipped vehicles.

getGiveWayMean()

double DTAVehicleType::getGiveWayMean

(

)

const

Returns vehicle's yield time.

getGuidanceMean()

double DTAVehicleType::getGuidanceMean

(

)

const

Returns the guidance acceptance level (value between 0 and 1)

getInitialEnergyLevel()

const DTAVehicleAttribute & DTAVehicleType::getInitialEnergyLevel

(

)

const

Return intial energy level of Vehicle for the Fuel & Battery Consumption Model.

getLengthMean()

double DTAVehicleType::getLengthMean

(

)

const

Returns vehicle's length mean.

getMaxAccelMean()

double DTAVehicleType::getMaxAccelMean

(

)

const

Returns vehicle's maximum acceleration mean.

getMaxCapacity()

double DTAVehicleType::getMaxCapacity

(

)

const

Returns the maximum number of passengers for this vehicle.

getMaxDecelMean()

double DTAVehicleType::getMaxDecelMean

(

)

const

Returns vehicle's maximum deceleration mean.

getMaxPathAlternatives()

int DTAVehicleType::getMaxPathAlternatives

(

)

const

Returns the maximum number of paths to be used by this vehicle type.

getMaxSpeedMean()

double DTAVehicleType::getMaxSpeedMean

(

)

const

Returns the maximum speed in m/s

getMaxSpeedMeanInKmH()

double DTAVehicleType::getMaxSpeedMeanInKmH

(

)

const

Returns the maximum speed in Km/h

getModalId()

int DTAVehicleType::getModalId

(

)

const

Returns the modal index going from 0 to len(DTANetwork::getPrivateVehicles)-1.

getNbOfPollutants()

uint DTAVehicleType::getNbOfPollutants

(

)

const

Returns the number of pollutants.

getNormalDecelMean()

double DTAVehicleType::getNormalDecelMean

(

)

const

Returns vehicle's normal deceleration mean.

getNumberIn()

uint DTAVehicleType::getNumberIn

(

)

const

Returns the total number of simulated vehicles that are inside the current simulation.

getNumberLostIn()

uint DTAVehicleType::getNumberLostIn

(

)

const

Returns the total number of lost vehicles that are inside the current simulation.

getNumberLostOut()

uint DTAVehicleType::getNumberLostOut

(

)

const

Returns the total number of lost vehicles that exited the current simulation.

getNumberOut()

uint DTAVehicleType::getNumberOut

(

)

const

Returns the total number of simulated vehicles that exited the current simulation.

getNumberWaiting()

uint DTAVehicleType::getNumberWaiting

(

)

Returns the total number of simulated vehicles waiting to enter into the network in the current simulation.

getODRoutesPercentage()

double DTAVehicleType::getODRoutesPercentage

(

)

const

Returns the percentage to use OD routes.

getPathAssignmentResultsPercentage()

double DTAVehicleType::getPathAssignmentResultsPercentage

(

)

const

Returns the percentage to use path assignment result.

getProbKeepFastLane()

double DTAVehicleType::getProbKeepFastLane

(

)

const

Returns the probability to keep the fast lane ( micro parameter )

getReactionTimeAtStopMeso()

double DTAVehicleType::getReactionTimeAtStopMeso

(

double

value01

)

const

Returns the mesoscopic reation time at traffic light using a random number value01.

getReactionTimeAtStopMicro()

double DTAVehicleType::getReactionTimeAtStopMicro

(

double

value01

)

const

Returns the microscopic reation time at stop using a random number value01.

getReactionTimeMeso()

double DTAVehicleType::getReactionTimeMeso

(

double

value01

)

const

Returns the mesoscopic reation time using a random number value01.

getReactionTimeMicro()

double DTAVehicleType::getReactionTimeMicro

(

double

value01

)

const

Returns the microscopic reation time using a random number value01.

getSpeedAcceptanceMean()

double DTAVehicleType::getSpeedAcceptanceMean

(

)

const

Returns vehicle's speed limit acceptance mean.

getValueOfTime()

const DTAVehicleAttribute & DTAVehicleType::getValueOfTime

(

)

const

Returns the value of time attribute description.

getValueOfTimeMean()

double DTAVehicleType::getValueOfTimeMean

(

)

const

Returns the value of time.

getWidthMean()

double DTAVehicleType::getWidthMean

(

)

const

Returns vehicle's width mean.

isValidFuelConsumptionData()

bool DTAVehicleType::isValidFuelConsumptionData

(

)

const

Returns true if the different fuel consumption parameters are correct.

isValidQuartetEmissionData()

bool DTAVehicleType::isValidQuartetEmissionData

(

)

const

Returns true if the different QUARTET emission parameters are correct.

printNumberVehicles()

QString DTAVehicleType::printNumberVehicles

(

)

Returns a string with the number of vehicles summary.

setMaxPathAlterntives()

void DTAVehicleType::setMaxPathAlterntives

(

int

value

)

Set the maximum number of paths to be used by this vehicle type.