Aimsun Next Scripting  22
Public Member Functions | Static Public Attributes | List of all members
GKTrafficDemandItem Class Reference
Inheritance diagram for GKTrafficDemandItem:
GKObject GKBaseObject GKCentroidVector GKODMatrix GKTrafficState GKPedestrianODMatrix

Public Member Functions

 GKTrafficDemandItem ()
 
GKProblemNetgetProblemNet () const
 
void setProblemNet (GKProblemNet *)
 
GKUserClassgetUserClass () const
 
void setUserClass (GKUserClass *userClass)
 
GKMobileAgentgetVehicle () const
 
void setVehicle (GKMobileAgent *avehicle)
 
void setInterval (const QTime &, const GKTimeDuration &)
 
void setFrom (const QTime &)
 
void setDuration (const GKTimeDuration &)
 
const QTime & getFrom () const
 
const GKTimeDurationgetDuration () const
 
bool equivalent (const GKTrafficDemandItem &) const
 
bool equivalent (const GKUserClass *uc, const QTime &, const GKTimeDuration &) const
 
QString getNameAutomatically (bool) 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 weekdayAtt
 
static uint seasonAtt
 
static uint weatherAtt
 
static uint eventAtt
 
static uint methodologyAtt
 
static uint fromAtt
 
static uint durationAtt
 
static uint subnetworkAtt
 
- 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 is valid for a vehicle type and a time interval (defined by an initial time and a duration).

It contains some informative attributes to classify the conditions and origin of this demand (Day, Season, Weather...)

Constructor & Destructor Documentation

◆ GKTrafficDemandItem()

GKTrafficDemandItem::GKTrafficDemandItem ( )

Member Function Documentation

◆ equivalent() [1/2]

bool GKTrafficDemandItem::equivalent ( const GKTrafficDemandItem ) const

Return true if the vehicle, from and duration are equals.

◆ equivalent() [2/2]

bool GKTrafficDemandItem::equivalent ( const GKUserClass uc,
const QTime &  ,
const GKTimeDuration  
) const

Return true if the vehicle, from and duration are equals.

◆ getDuration()

const GKTimeDuration & GKTrafficDemandItem::getDuration ( ) const

Demand item duration.

◆ getFrom()

const QTime & GKTrafficDemandItem::getFrom ( ) const

Demand item initial time.

◆ getNameAutomatically()

QString GKTrafficDemandItem::getNameAutomatically ( bool  ) const

Gets the name of this object automatically based on the vehicle type, the from and the duration. The string will be:

  • if longName is true:
  • if longName is false:

◆ getProblemNet()

GKProblemNet * GKTrafficDemandItem::getProblemNet ( ) const

Is a demand item for a subnetwork or for the whole network.

◆ getUserClass()

GKUserClass * GKTrafficDemandItem::getUserClass ( ) const

User class (contains the vehicle)

◆ getVehicle()

GKMobileAgent * GKTrafficDemandItem::getVehicle ( ) const

Helper, equivalent to getUserClass()->getVehicle()

◆ setDuration()

void GKTrafficDemandItem::setDuration ( const GKTimeDuration )

Demand item duration.

◆ setFrom()

void GKTrafficDemandItem::setFrom ( const QTime &  )

Demand item initial time.

◆ setInterval()

void GKTrafficDemandItem::setInterval ( const QTime &  ,
const GKTimeDuration  
)

Demand item initial time and duration.

◆ setProblemNet()

void GKTrafficDemandItem::setProblemNet ( GKProblemNet )

Is a demand item for a subnetwork or for the whole network.

◆ setUserClass()

void GKTrafficDemandItem::setUserClass ( GKUserClass userClass)

User class (contains the vehicle)

◆ setVehicle()

void GKTrafficDemandItem::setVehicle ( GKMobileAgent avehicle)

Deprecated. It is equivalent to: myUserClass = GKUserClass::createUserClass( getModel(), avehicle, None ); myUserClass->setVehicle(avehicle);

So it is safier to get the userClass first (or even create it by GKUserClass::createUserClass) and then set the vehicle; otherwise, it is actually creating userClasses without warning or modifying those user classes that you might not really want to change.

Member Data Documentation

◆ durationAtt

uint GKTrafficDemandItem::durationAtt
static

Demand item duration.

◆ eventAtt

uint GKTrafficDemandItem::eventAtt
static

Event:

  • 0: Not Set
  • 1: No Event
  • 2: Fair
  • 3: Sports

◆ fromAtt

uint GKTrafficDemandItem::fromAtt
static

Demand item initial time.

◆ methodologyAtt

uint GKTrafficDemandItem::methodologyAtt
static

Methodology:

  • 0: Not Set
  • 1: User-Edited
  • 2: Demand-Modeled
  • 3: Adjusted
  • 4: Traversal
  • 5: Assigned

◆ seasonAtt

uint GKTrafficDemandItem::seasonAtt
static

Season:

  • 0: Not Set
  • 1: Spring
  • 2: Summer
  • 3: Autumn
  • 4: Winter

◆ subnetworkAtt

uint GKTrafficDemandItem::subnetworkAtt
static

Traffic demand item subnetwork if it belongs to any.

◆ weatherAtt

uint GKTrafficDemandItem::weatherAtt
static

Weather:

  • 0: Not Set
  • 1: Dry
  • 2: Sunny
  • 3: Wet
  • 4: Rainy
  • 5: Snowy
  • 6: Foggy

◆ weekdayAtt

uint GKTrafficDemandItem::weekdayAtt
static

Week of the day of this demand item:

  • 0: Not Set
  • 1: Monday
  • 2: Tuesday
  • 3: Wednesday
  • 4: Thursday
  • 5: Friday
  • 6: Saturday
  • 7: Sunday

© Aimsun SLU
Aimsun ®