Aimsun Next Scripting: GKTrafficArrivals Class Reference
Aimsun Next Scripting  22
Public Member Functions | Static Public Attributes | List of all members
GKTrafficArrivals Class Reference
Inheritance diagram for GKTrafficArrivals:
GKObject GKBaseObject

Public Member Functions

 GKTrafficArrivals ()
 
void setFileName (const QString &aFileName)
 
QString getFileName ()
 
void setSimulatorName (const QString &name)
 
QString getSimulatorName () const
 
void setSimulatorVersion (const QString &name)
 
QString getSimulatorVersion () const
 
void setReplication (GKReplication *replication)
 
const GKReplicationgetReplication () const
 
void setInitialTime (QTime iniTime)
 
QTime getInitialTime () const
 
void setDuration (GKTimeDuration dur)
 
GKTimeDuration getDuration () const
 
void setProfilingInterval (GKTimeDuration dur)
 
GKTimeDuration getProfilingInterval () const
 
void setDemandType (GKTrafficDemand::GKTrafficDemandType type)
 
GKTrafficDemand::GKTrafficDemandType getDemandType () const
 
QDateTime getGenerationDate () const
 
void setProblemNet (GKProblemNet *aProblemNet)
 
GKProblemNetgetProblemNet () const
 
void clear ()
 
void storeData ()
 
void restoreData ()
 
bool hasBeenRetrieved () const
 
void setHasBeenRetrieved (bool value)
 
bool isAutoRetrieve () const
 
void setAutoRetrieve (bool value)
 
const QVector< uint > & getVehicleIDs () const
 
GKTimeDuration getWarmUp () const
 
uint getNbVehiclesForType (uint vehId) const
 
void setNbVehiclesForType (uint vehId, uint interval, uint nbVehicles)
 
QVector< uint > getIntervalForVeh (uint vehId) const
 
- Public Member Functions inherited from GKObject
 GKObject ()
 
 GKObject (const GKObject &o)
 
virtual void addedToCatalog ()
 
virtual void removedFromCatalog ()
 
uint getTick () const
 
virtual void increaseTick ()
 
void setTick (uint t)
 
virtual GKObjectclone (bool addItToModel=true) const
 
virtual GKObjectcloneAsTemporary (bool addItToModel=true) const
 
GKFoldergetCreateRootFolder ()
 
GKFoldergetRootFolder () const
 
void setRootFolder (GKFolder *afolder)
 
GKFolderfindFolder (const QString &byName) const
 
QVector< GKFolder * > getParentFolders () const
 
bool isDataValueNull (const GKColumn *attr) const
 
virtual QVariant * getDataValue (const GKColumn *attr, bool *deleteit, const GKContext &context=GKContext::anyContext) const
 
QVariant * getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const
 
virtual void setDataValue (const GKColumn *attr, const QVariant &v)
 
void setDataValueByID (uint attrId, const QVariant &v)
 
virtual void setDataValueObject (const GKColumn *attr, const GKObject *obj)
 
void setDataValueObjectByID (uint attrId, const GKObject *obj)
 
virtual void setDataValueDouble (const GKColumn *attr, double v)
 
void setDataValueDoubleByID (uint attrId, double v)
 
virtual double getDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double *deviation=NULL) const
 
double getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const
 
bool hasAnyTSWithData () const
 
virtual GKTimeSeriegetDataValueTS (const GKColumn *attr) const
 
GKTimeSeriegetDataValueTSByID (uint attrId) const
 
virtual void setDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription=NULL, int reservedSize=0)
 
virtual void setDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, double lowerValue, GKTSDescription *aDescription=NULL, int reservedSize=0)
 
virtual void setDataValueInSingleTS (const GKColumn *attr, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription)
 
void setDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double value, double deviation, GKTSDescription *aDescription=NULL, int reservedSize=0)
 
virtual void setAggregatedValueInTS (const GKColumn *attr, double value, double deviation, GKTSDescription *aDescription=NULL)
 
void setAggregatedValueInTSByID (uint attrId, double value, double deviation, GKTSDescription *aDescription=NULL)
 
virtual void clearDataValueTS (const GKColumn *attr, GKTSDescription *aDescription=NULL)
 
void clearDataValueTSByID (uint attrId, GKTSDescription *aDescription=NULL)
 
virtual int getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
int getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual double getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
double getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
QString getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
QString getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual bool getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
bool getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual GKObjectgetDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
GKObjectgetDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
QDate getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
QDate getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
QTime getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
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
 
GKTimeDuration getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
GKTimeDuration getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
void removeDataValue (const GKColumn *attr)
 
void removeDataValueByID (uint attrId)
 
const QString & getDescription () const
 
void setDescription (const QString &adescription)
 
const QString & getExternalId () const
 
void setExternalId (const QString &anId)
 
virtual GKObjectDelCmd * getDelCmd ()
 
virtual GKObjectConnectionDelCmd * getDelConnectionCmd (GKObject *target)
 
virtual void nonCommandObjectRemoved (GKObject *)
 
virtual void init ()
 
virtual void setId (uint aid, GKModel *model)
 
uint getId () const
 
QUuid getUUID () const
 
virtual void setName (const QString &aname)
 
const QString & getName () const
 
QString getExtendedId (IdentifierForm form=eIdentifierDefault) const
 
QString getNameOrExtendedId (IdentifierForm form=eIdentifierDefault) const
 
virtual const QString & getTypeName () const
 
virtual QString getTypeExternalName () const
 
const GKObjectgetMaster () const
 
GKTypegetType () const
 
virtual void setType (GKType *atype)
 
bool isA (const GKType *atype) const
 
bool isA (const QString &typeName) const
 
virtual void setModel (GKModel *amodel)
 
GKModelgetModel () const
 
virtual void setLock (GKLockType atype)
 
GKLockType getLock () const
 
virtual bool canBeDeleted () const
 
virtual bool canBeModified () const
 
virtual bool canBeEdited () const
 
GKObjectStatus getStatus () const
 
virtual void setStatus (const GKObjectStatus astatus)
 
void notifyStatusChange ()
 
bool isTemporary () const
 
void setTemporary (bool value)
 
bool isExternal () const
 
void setExternal (bool value)
 
virtual void preferencesChanged ()
 
void removeColumn (GKColumn *column)
 
void resetColumn (GKColumn *column)
 
- 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
 

Static Public Attributes

static uint fileNameAttr
 
static uint autoRetrieveAtt
 
static uint retrievedAtt
 
- Static Public Attributes inherited from GKObject
static uint typeNameAtt
 
static uint typeExternalNameAtt
 
static uint revisedAtt
 
- Static Public Attributes inherited from GKBaseObject
Py_END_ALLOW_THREADS static End uint idAtt
 
static uint nameAtt
 
static uint externalIdAtt
 
static uint descriptionAtt
 

Additional Inherited Members

- Public Types inherited from GKObject
enum  IdentifierFormFlag {
  eIdentifierDefault , eIdentifierId , eIdentifierName , eIdentifierExternalId ,
  eIdentifierTypeExternalName , eIdentifierDescription , eIdentifierStandard , eIdentifierStandardWithType ,
  eIdentifierAll
}
 
enum  GKLockType { eNone , eModification , eDelete , eModificationDelete }
 
enum  GKObjectStatus { eNew , eSaved , eModified , eDeleted }
 
typedef QFlags< GKObject::IdentifierFormFlagIdentifierForm
 
- Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObjectbase = (GKBaseObject*)sipCpp
 
 sipType = 0
 

Detailed Description

It stores all private vehicle arrival times into a file and the information of the paths being used by these vehicles. When loading a new micro simulation, the user can select a traffic arrival object to define which vehicles will be generated, when and where. Transit Vehicles are not considered at the moment.

Constructor & Destructor Documentation

◆ GKTrafficArrivals()

GKTrafficArrivals::GKTrafficArrivals ( )

Member Function Documentation

◆ clear()

void GKTrafficArrivals::clear ( )

Resets data in these vehicle arrival object

◆ getDemandType()

GKTrafficDemand::GKTrafficDemandType GKTrafficArrivals::getDemandType ( ) const

The demand type used to generate these vehicle arrival times

◆ getDuration()

GKTimeDuration GKTrafficArrivals::getDuration ( ) const

Returns the duration for this traffic arrivals.

◆ getFileName()

QString GKTrafficArrivals::getFileName ( )

The file where the info is.

◆ getGenerationDate()

QDateTime GKTrafficArrivals::getGenerationDate ( ) const

When these vehicle arrival times were generated.

◆ getInitialTime()

QTime GKTrafficArrivals::getInitialTime ( ) const

Returns the initial time for this traffic arrivals.

◆ getIntervalForVeh()

QVector< uint > GKTrafficArrivals::getIntervalForVeh ( uint  vehId) const

getIntervalForVeh returns all Intervals of each vehicle

◆ getNbVehiclesForType()

uint GKTrafficArrivals::getNbVehiclesForType ( uint  vehId) const

It gives the number of simulation vehicles of the specified vehicle type ID that are included in the Traffic Arrivals object for its whole duration

◆ getProblemNet()

GKProblemNet * GKTrafficArrivals::getProblemNet ( ) const

Returns the Subnetwork this traffic arrivals belongs to.

◆ getProfilingInterval()

GKTimeDuration GKTrafficArrivals::getProfilingInterval ( ) const

Gets the interval to store how many vehicles of each type are generated in order to be able to have some kinf of profile information.

◆ getReplication()

const GKReplication * GKTrafficArrivals::getReplication ( ) const

The replication used to generate these vehicle arrival times

◆ getSimulatorName()

QString GKTrafficArrivals::getSimulatorName ( ) const

The simulator used to generate these vehicle arrival times

◆ getSimulatorVersion()

QString GKTrafficArrivals::getSimulatorVersion ( ) const

The simulator version used to generate these vehicle arrival times

◆ getVehicleIDs()

const QVector< uint > & GKTrafficArrivals::getVehicleIDs ( ) const

getVehicles returns the vehicles ID sorted using the modal index

◆ getWarmUp()

GKTimeDuration GKTrafficArrivals::getWarmUp ( ) const

getWarmUp returns the warm up duration of this traffic arrivals

◆ hasBeenRetrieved()

bool GKTrafficArrivals::hasBeenRetrieved ( ) const

Returns true if the vehicle data has been retrieved from the specified file or false otherwise

◆ isAutoRetrieve()

bool GKTrafficArrivals::isAutoRetrieve ( ) const

Get the autoRetrieve attribute

◆ restoreData()

void GKTrafficArrivals::restoreData ( )

Restores the vehicle data in from a file

◆ setAutoRetrieve()

void GKTrafficArrivals::setAutoRetrieve ( bool  value)

Set the autoRetrieve attribute

◆ setDemandType()

void GKTrafficArrivals::setDemandType ( GKTrafficDemand::GKTrafficDemandType  type)

The demand type used to generate these vehicle arrival times

◆ setDuration()

void GKTrafficArrivals::setDuration ( GKTimeDuration  dur)

Sets the duration for this traffic arrivals.

◆ setFileName()

void GKTrafficArrivals::setFileName ( const QString &  aFileName)

The file where the info is.

◆ setHasBeenRetrieved()

void GKTrafficArrivals::setHasBeenRetrieved ( bool  value)

Set the retrieved attribute

◆ setInitialTime()

void GKTrafficArrivals::setInitialTime ( QTime  iniTime)

Sets the initial time for this traffic arrivals.

◆ setNbVehiclesForType()

void GKTrafficArrivals::setNbVehiclesForType ( uint  vehId,
uint  interval,
uint  nbVehicles 
)

It sets the number of simulation vehicles of the specified vehicle type ID and for the specified interval (from 0 to nbintervals being each interval of a duration equivalent to the ProfilingInterval

◆ setProblemNet()

void GKTrafficArrivals::setProblemNet ( GKProblemNet aProblemNet)

Sets the Subnetwork this traffic arrivals belongs to.

◆ setProfilingInterval()

void GKTrafficArrivals::setProfilingInterval ( GKTimeDuration  dur)

Sets the interval to store how many vehicles of each type are generated in order to be able to have some kinf of profile information.

◆ setReplication()

void GKTrafficArrivals::setReplication ( GKReplication replication)

The replication used to generate these vehicle arrival times

◆ setSimulatorName()

void GKTrafficArrivals::setSimulatorName ( const QString &  name)

The simulator used to generate these vehicle arrival times

◆ setSimulatorVersion()

void GKTrafficArrivals::setSimulatorVersion ( const QString &  name)

The simulator version used to generate these vehicle arrival times

◆ storeData()

void GKTrafficArrivals::storeData ( )

Stores the vehicle data in a file

Member Data Documentation

◆ autoRetrieveAtt

uint GKTrafficArrivals::autoRetrieveAtt
static

If true auto retrieve when loading the network.

◆ fileNameAttr

uint GKTrafficArrivals::fileNameAttr
static

The file name (a QString) where the info is.

◆ retrievedAtt

uint GKTrafficArrivals::retrievedAtt
static

Has the external data been retrieved?

© Aimsun SLU
Aimsun ®