Aimsun Next Scripting: DTASection Class Reference
Aimsun Next Scripting  22
Public Types | Public Member Functions | List of all members
DTASection Class Reference
Inheritance diagram for DTASection:
GKSimulatedObject GKBaseObject

Public Types

enum  DTABehaviourModelType { eMicro , eMeso }
 

Public Member Functions

 DTASection ()
 
uint getId () const
 
DTABehaviourModelType getBehaviourModel () const
 
uint getTotalNumberLanes () const
 
const GKRoadTypegetRoadType () const
 
bool getIsEntrance () const
 
bool getIsExit () const
 
bool allowsVehicleType (DTAVehicleType *vehType) const
 
bool hasReservedLanes () const
 
bool hasReservedLanes (DTAVehicleType *vehType) const
 
int getNbFullLanes () const
 
uint getNumberTurns () const
 
bool allCentralLanesReserved () const
 
double getSpeed () const
 
double getSpeed_ms () const
 
double getCapacity () const
 
double getUserDefinedCost () const
 
double getUserDefinedCost2 () const
 
double getUserDefinedCost3 () const
 
double getAdditionalVolume () const
 
double length2D () const
 
double length3D () const
 
double length3DKm () const
 
double getMaxSpeed () const
 
double getMaxSpeedInKmH () const
 
double getSlope () const
 
double getStaFlow (DTAManager *dtaManager) const
 
double getStaDensity (DTAManager *dtaManager) const
 
double getStaSpeed (DTAManager *dtaManager) const
 
double getStaTravelT (DTAManager *dtaManager) const
 
double getStaDelayT (DTAManager *dtaManager) const
 
double getStaStopT (DTAManager *dtaManager) const
 
double getStaNbStopVeh (DTAManager *dtaManager) const
 
double getStaQueueLMean (DTAManager *dtaManager) const
 
double getStaQueueLMax (DTAManager *dtaManager) const
 
double getPastCost (DTAManager *dtaManager, int index) const
 
double getStaFlowVT (DTAManager *dtaManager, DTAVehicleType *vehType) const
 
double getStaDensityVT (DTAManager *dtaManager, DTAVehicleType *vehType) const
 
double getStaSpeedVT (DTAManager *dtaManager, DTAVehicleType *vehType) const
 
double getStaTravelTVT (DTAManager *dtaManager, DTAVehicleType *vehType) const
 
double getStaDelayTVT (DTAManager *dtaManager, DTAVehicleType *vehType) const
 
double getStaStopTVT (DTAManager *dtaManager, DTAVehicleType *vehType) const
 
double getStaNbStopVehVT (DTAManager *dtaManager, DTAVehicleType *vehType) const
 
double getStaQueueLMeanVT (DTAManager *dtaManager, DTAVehicleType *vehType) const
 
double getStaQueueLMaxVT (DTAManager *dtaManager, DTAVehicleType *vehType) const
 
double getStaFlowVT (DTAManager *dtaManager, const DTAUserClass *gkUserClass) const
 
double getStaDensityVT (DTAManager *dtaManager, const DTAUserClass *gkUserClass) const
 
double getStaSpeedVT (DTAManager *dtaManager, const DTAUserClass *gkUserClass) const
 
double getStaTravelTVT (DTAManager *dtaManager, const DTAUserClass *gkUserClass) const
 
double getStaDelayTVT (DTAManager *dtaManager, const DTAUserClass *gkUserClass) const
 
double getStaStopTVT (DTAManager *dtaManager, const DTAUserClass *gkUserClass) const
 
double getStaNbStopVehVT (DTAManager *dtaManager, const DTAUserClass *gkUserClass) const
 
double getStaQueueLMeanVT (DTAManager *dtaManager, const DTAUserClass *gkUserClass) const
 
double getStaQueueLMaxVT (DTAManager *dtaManager, const DTAUserClass *gkUserClass) const
 
double getFreeFlowTravelTime (DTAManager *dtaManager, DTAVehicleType *vehType) const
 
double getPastCostVT (DTAManager *dtaManager, const DTAVehicleType *vehType, int index) const
 
- Public Member Functions inherited from GKSimulatedObject
 GKSimulatedObject ()
 
 GKSimulatedObject (const GKObject *master, GKModelConnection *connection=NULL)
 
virtual QString getTypeExternalName () const
 
void setMaster (GKObject *master)
 
const GKObjectgetMaster () const
 
virtual quint32 getId () const
 
virtual const QString & getName () const
 
virtual const QString & getExternalId () const
 
virtual const QString & getDescription () const
 
virtual GKModelgetModel () const
 
virtual GKTypegetType () 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 GKTimeSeriegetDataValueTS (const GKColumn *attr) const
 
virtual GKTimeSeriegetDataValueTSByID (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 GKObjectgetDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
virtual GKObjectgetDataValueObjectByID (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 GKObjectgetMaster () const =0
 
virtual const QString & getName () const =0
 
virtual const QString & getExternalId () const =0
 
virtual const QString & getDescription () const =0
 
virtual GKModelgetModel () 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 GKTimeSeriegetDataValueTS (const GKColumn *attr) const =0
 
virtual GKTimeSeriegetDataValueTSByID (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 GKObjectgetDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0
 
virtual GKObjectgetDataValueObjectByID (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 GKBaseObjectbase = (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
 

Member Enumeration Documentation

◆ DTABehaviourModelType

Enumerator
eMicro 
eMeso 

Constructor & Destructor Documentation

◆ DTASection()

DTASection::DTASection ( )

Member Function Documentation

◆ allCentralLanesReserved()

bool DTASection::allCentralLanesReserved ( ) const

Returns true if all central lanes are reserved.

◆ allowsVehicleType()

bool DTASection::allowsVehicleType ( DTAVehicleType vehType) const

Returns true if vehicle vehType can go through this section.

◆ getAdditionalVolume()

double DTASection::getAdditionalVolume ( ) const

Returns the section additional volume.

◆ getBehaviourModel()

DTABehaviourModelType DTASection::getBehaviourModel ( ) const

◆ getCapacity()

double DTASection::getCapacity ( ) const

Returns the section capacity.

◆ getFreeFlowTravelTime()

double DTASection::getFreeFlowTravelTime ( DTAManager dtaManager,
DTAVehicleType vehType 
) const

Returns the free flow travel time considering the vehicle type.

◆ getId()

uint DTASection::getId ( ) const
virtual

Returns the Aimsun kernel id of this section.

Reimplemented from GKSimulatedObject.

◆ getIsEntrance()

bool DTASection::getIsEntrance ( ) const

Returns true if the section is connected to an entrance centroid

◆ getIsExit()

bool DTASection::getIsExit ( ) const

Returns true if the section is connected to an exit centroid

◆ getMaxSpeed()

double DTASection::getMaxSpeed ( ) const

Returns the section speed in the network units, either Km/h or miles/h

◆ getMaxSpeedInKmH()

double DTASection::getMaxSpeedInKmH ( ) const

Returns the section speed in Km/h

◆ getNbFullLanes()

int DTASection::getNbFullLanes ( ) const

Returns the number of full or central lanes.

◆ getNumberTurns()

uint DTASection::getNumberTurns ( ) const

Returns the number of turns.

◆ getPastCost()

double DTASection::getPastCost ( DTAManager dtaManager,
int  index 
) const

Returns the past cost that has been read from the replication that has been set for the past costs. The index parameter defines the shift from the current interval. So index = 0 means that the returned path cost will be from the same interval. index = 1 means the next interval and index = -1 the previous interval.

◆ getPastCostVT()

double DTASection::getPastCostVT ( DTAManager dtaManager,
const DTAVehicleType vehType,
int  index 
) const

Returns the past cost that has been read from the replication that has been set for the past costs. The index parameter defines the shift from the current interval. So index = 0 means that the returned path cost will be from the same interval. index = 1 means the next interval and index = -1 the previous interval.

◆ getRoadType()

const GKRoadType * DTASection::getRoadType ( ) const

Returns the road type of the section.

◆ getSlope()

double DTASection::getSlope ( ) const

Returns the section slope.

◆ getSpeed()

double DTASection::getSpeed ( ) const

Returns the speed in either m/s (micro/meso) or km/h (macro)

◆ getSpeed_ms()

double DTASection::getSpeed_ms ( ) const

Returns the speed in m/s.

◆ getStaDelayT()

double DTASection::getStaDelayT ( DTAManager dtaManager) const

Returns the mean delay time for the last route choice interval/s of all exit links.

◆ getStaDelayTVT() [1/2]

double DTASection::getStaDelayTVT ( DTAManager dtaManager,
const DTAUserClass gkUserClass 
) const

Returns the mean delay time for the last route choice interval/s considering the user class of all exit links.

◆ getStaDelayTVT() [2/2]

double DTASection::getStaDelayTVT ( DTAManager dtaManager,
DTAVehicleType vehType 
) const

Returns the mean delay time for the last route choice interval/s considering the vehicle type vehType of all exit links.

◆ getStaDensity()

double DTASection::getStaDensity ( DTAManager dtaManager) const

Returns the density for the last route choice interval/s.

◆ getStaDensityVT() [1/2]

double DTASection::getStaDensityVT ( DTAManager dtaManager,
const DTAUserClass gkUserClass 
) const

Returns the density for the last route choice interval/s considering the user class.

◆ getStaDensityVT() [2/2]

double DTASection::getStaDensityVT ( DTAManager dtaManager,
DTAVehicleType vehType 
) const

Returns the density for the last route choice interval/s considering the vehicle type vehType.

◆ getStaFlow()

double DTASection::getStaFlow ( DTAManager dtaManager) const

Returns the flow for the last route choice interval/s.

◆ getStaFlowVT() [1/2]

double DTASection::getStaFlowVT ( DTAManager dtaManager,
const DTAUserClass gkUserClass 
) const

Returns the flow for the last route choice interval/s considering the user class.

◆ getStaFlowVT() [2/2]

double DTASection::getStaFlowVT ( DTAManager dtaManager,
DTAVehicleType vehType 
) const

Returns the flow for the last route choice interval/s considering the vehicle type vehType.

◆ getStaNbStopVeh()

double DTASection::getStaNbStopVeh ( DTAManager dtaManager) const

Returns the number of stops for the last route choice interval/s.

◆ getStaNbStopVehVT() [1/2]

double DTASection::getStaNbStopVehVT ( DTAManager dtaManager,
const DTAUserClass gkUserClass 
) const

Returns the number of stops for the last route choice interval/s considering the user class.

◆ getStaNbStopVehVT() [2/2]

double DTASection::getStaNbStopVehVT ( DTAManager dtaManager,
DTAVehicleType vehType 
) const

Returns the number of stops for the last route choice interval/s considering the vehicle type vehType.

◆ getStaQueueLMax()

double DTASection::getStaQueueLMax ( DTAManager dtaManager) const

Returns the max queue length for the last route choice interval/s. Only available when using the micro simulation engine.

◆ getStaQueueLMaxVT() [1/2]

double DTASection::getStaQueueLMaxVT ( DTAManager dtaManager,
const DTAUserClass gkUserClass 
) const

Returns the max queue length for the last route choice interval/s. Only available when using the micro simulation engine and considering the user class.

◆ getStaQueueLMaxVT() [2/2]

double DTASection::getStaQueueLMaxVT ( DTAManager dtaManager,
DTAVehicleType vehType 
) const

Returns the max queue length for the last route choice interval/s. Only available when using the micro simulation engine and considering the vehicle type vehType.

◆ getStaQueueLMean()

double DTASection::getStaQueueLMean ( DTAManager dtaManager) const

Returns the mean queue length for the last route choice interval/s. Only available when using the micro simulation engine.

◆ getStaQueueLMeanVT() [1/2]

double DTASection::getStaQueueLMeanVT ( DTAManager dtaManager,
const DTAUserClass gkUserClass 
) const

Returns the mean queue length for the last route choice interval/s. Only available when using the micro simulation engine and considering the user class.

◆ getStaQueueLMeanVT() [2/2]

double DTASection::getStaQueueLMeanVT ( DTAManager dtaManager,
DTAVehicleType vehType 
) const

Returns the mean queue length for the last route choice interval/s. Only available when using the micro simulation engine and considering the vehicle type vehType.

◆ getStaSpeed()

double DTASection::getStaSpeed ( DTAManager dtaManager) const

Returns the mean speed for the last route choice interval/s of all exit links.

◆ getStaSpeedVT() [1/2]

double DTASection::getStaSpeedVT ( DTAManager dtaManager,
const DTAUserClass gkUserClass 
) const

Returns the mean speed for the last route choice interval/s considering the user class of all exit links.

◆ getStaSpeedVT() [2/2]

double DTASection::getStaSpeedVT ( DTAManager dtaManager,
DTAVehicleType vehType 
) const

Returns the mean speed for the last route choice interval/s considering the vehicle type vehType of all exit links.

◆ getStaStopT()

double DTASection::getStaStopT ( DTAManager dtaManager) const

Returns the stop time for the last route choice interval/s.

◆ getStaStopTVT() [1/2]

double DTASection::getStaStopTVT ( DTAManager dtaManager,
const DTAUserClass gkUserClass 
) const

Returns the stop time for the last route choice interval/s considering the user class.

◆ getStaStopTVT() [2/2]

double DTASection::getStaStopTVT ( DTAManager dtaManager,
DTAVehicleType vehType 
) const

Returns the stop time for the last route choice interval/s considering the vehicle type vehType.

◆ getStaTravelT()

double DTASection::getStaTravelT ( DTAManager dtaManager) const

Returns the mean travel time for the last route choice interval/s of all exit links.

◆ getStaTravelTVT() [1/2]

double DTASection::getStaTravelTVT ( DTAManager dtaManager,
const DTAUserClass gkUserClass 
) const

Returns the mean travel time for the last route choice interval/s considering the user class of all exit links.

◆ getStaTravelTVT() [2/2]

double DTASection::getStaTravelTVT ( DTAManager dtaManager,
DTAVehicleType vehType 
) const

Returns the mean travel time for the last route choice interval/s considering the vehicle type vehType of all exit links.

◆ getTotalNumberLanes()

uint DTASection::getTotalNumberLanes ( ) const

Returns the total number of lanes of this section.

◆ getUserDefinedCost()

double DTASection::getUserDefinedCost ( ) const

Returns the section user defined cost.

◆ getUserDefinedCost2()

double DTASection::getUserDefinedCost2 ( ) const

Returns the section user defined cost 2.

◆ getUserDefinedCost3()

double DTASection::getUserDefinedCost3 ( ) const

Returns the section user defined cost 3.

◆ hasReservedLanes() [1/2]

bool DTASection::hasReservedLanes ( ) const

Returns if this sections has reserved lanes.

◆ hasReservedLanes() [2/2]

bool DTASection::hasReservedLanes ( DTAVehicleType vehType) const

Returns if this sections has reserved lanes by a specific vehicle type.

◆ length2D()

double DTASection::length2D ( ) const

Returns the section length in meters.

◆ length3D()

double DTASection::length3D ( ) const

Returns the section length in meters.

◆ length3DKm()

double DTASection::length3DKm ( ) const

Returns the section length in km.

© Aimsun SLU
Aimsun ®