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

Public Types

enum  Side { eNone =0 , eOrigin =1 , eDestination =2 }
 
- 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 Member Functions

 ModalSplitScenario ()
 
 ~ModalSplitScenario ()
 
void removeTripMatrices ()
 
void setParkingSide (Side side)
 
Side parkingSide () const
 
void setModalSplitSide (Side side)
 
Side getModalSplitSide () const
 
void setStoreResults (bool value)
 
bool storeResults () const
 
void setTimePeriod (GKTimePeriod *iTimePeriod)
 
GKTimePeriodtimePeriod () const
 
void setDataSet (GKDistributionDataSet *dataSet)
 
GKDistributionDataSetdataSet () const
 
void setCarAvailabilityDistinction (int iValue)
 
int getCarAvailabilityDistinction () const
 
const ModalSplitTripMatricesUtiltripMatricesData () const
 
void setTripMatricesData (const ModalSplitTripMatricesUtil &iTripMatricesData)
 
GKODMatrixgetComponentSkim (const GKODMatrix *iTripMatrix, const GKTransportationMode *iMode, const GKFunctionComponent *iComponent) const
 
void setComponentSkim (const GKODMatrix *iTripMatrix, const GKTransportationMode *iMode, const GKFunctionComponent *iComponent, GKODMatrix *iSkim)
 
void removeComponentSkim (const GKODMatrix *iTripMatrix, const GKTransportationMode *iMode, const GKFunctionComponent *iComponent)
 
GKODMatrixgetUserDefinedSkim (const GKODMatrix *iTripMatrix, const GKTransportationMode *iMode, const uint iColumnIndex) const
 
void setUserDefinedSkim (const GKODMatrix *iTripMatrix, const GKTransportationMode *iMode, const uint iColumnIndex, GKODMatrix *iSkim)
 
void removeUserDefinedSkim (const GKODMatrix *iTripMatrix, const GKTransportationMode *iMode, const uint iColumnIndex)
 
QVector< GKODMatrix * > getAllSkims (const GKODMatrix *iTripMatrix, const GKTransportationMode *iMode) const
 
QVector< GKTripPurpose * > getPurposes () const
 
QVector< GKVehicle * > getVehicles () const
 
QVector< GKUserClass * > getUsers () const
 
std::vector< const GKODMatrix * > getMatrices () const
 
- Public Member Functions inherited from GKGenericScenario
 GKGenericScenario ()
 
void addExperiment (GKGenericExperiment *experiment)
 
void removeExperiment (GKGenericExperiment *experiment)
 
const GKFoldergetExperiments () const
 
const GKDataBaseInfogetDB (bool returnProjectDB) const
 
void setDB (const GKDataBaseInfo &db)
 
const QDate & getDate () const
 
void setDate (const QDate &aDate)
 
const GKTrafficDemandgetDemand () const
 
void setDemand (const GKTrafficDemand *ademand)
 
const GKMasterControlPlangetMasterControlPlan () const
 
void setMasterControlPlan (const GKMasterControlPlan *amasterCP)
 
GKPublicLinePlangetPublicLinePlan () const
 
void setPublicLinePlan (GKPublicLinePlan *aplan)
 
GKRealDataSetgetRealDataSet () const
 
void setRealDataSet (GKRealDataSet *dataSet)
 
void setProblemNet (GKProblemNet *apn)
 
GKProblemNetgetProblemNet () const
 
void setValueForVariable (const QString &variable, const QString &value)
 
const QString & getValueForVariable (const QString &variable) const
 
const QMap< QString, QString > & getVariables () const
 
void setVariables (const QMap< QString, QString > &newList)
 
const GKFoldergetTrafficDemands () const
 
const QVector< const GKGeometryConfiguration * > & getGeometryConfigurations () const
 
void setGeometryConfigurations (const QVector< const GKGeometryConfiguration * > &value)
 
bool usesGeometryConfiguration (const GKGeometryConfiguration *configuration) const
 
void addGeometryConfiguration (const GKGeometryConfiguration *configuration)
 
void removeGeometryConfiguration (const GKGeometryConfiguration *configuration)
 
void addStrategy (GKStrategy *strategy)
 
void removeStrategy (GKStrategy *strategy)
 
void addTrafficCondition (GKSimulationEvent *condition)
 
void removeTrafficCondition (GKSimulationEvent *condition)
 
void removeAllStrategiesAndConditions ()
 
const QList< GKObject * > & getStrategiesAndConditions () const
 
bool usesStrategyOrCondition (GKObject *strategyOrCondition) const
 
void setInputPathAssignmentPlan (GKPathAssignmentPlan *)
 
GKPathAssignmentPlangetInputPathAssignmentPlan () const
 
void setModes (QVector< GKTransportationMode * > modes)
 
QVector< GKTransportationMode * > getModes () const
 
void addMode (GKTransportationMode *mode)
 
void removeMode (GKTransportationMode *mode)
 
- 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
 

Additional Inherited Members

- Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObjectbase = (GKBaseObject*)sipCpp
 
 sipType = 0
 
- Static Public Attributes inherited from GKGenericScenario
static uint dateAtt
 
static uint weekdayAtt
 
static uint seasonAtt
 
static uint weatherAtt
 
static uint eventAtt
 
static uint methodologyAtt
 
- 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
 

Member Enumeration Documentation

◆ Side

Enumerator
eNone 
eOrigin 
eDestination 

Constructor & Destructor Documentation

◆ ModalSplitScenario()

ModalSplitScenario::ModalSplitScenario ( )

◆ ~ModalSplitScenario()

ModalSplitScenario::~ModalSplitScenario ( )

Member Function Documentation

◆ dataSet()

GKDistributionDataSet * ModalSplitScenario::dataSet ( ) const

Get the Data Set in the scenario.

◆ getAllSkims()

QVector< GKODMatrix * > ModalSplitScenario::getAllSkims ( const GKODMatrix iTripMatrix,
const GKTransportationMode iMode 
) const

Get all skim matrices for specified GKODMatrix trip matrix and GKTransportationMode *‍/.

◆ getCarAvailabilityDistinction()

int ModalSplitScenario::getCarAvailabilityDistinction ( ) const

Get whether the modal split will consider Car Availability.

◆ getComponentSkim()

GKODMatrix * ModalSplitScenario::getComponentSkim ( const GKODMatrix iTripMatrix,
const GKTransportationMode iMode,
const GKFunctionComponent iComponent 
) const

Get the GKCostComponent skim matrix for specific GKODMatrix trip matrix, GKTransportationMode and GKFunctionComponent *‍/.

◆ getMatrices()

std::vector< const GKODMatrix * > ModalSplitScenario::getMatrices ( ) const

Get individuals trip matrices.

◆ getModalSplitSide()

Side ModalSplitScenario::getModalSplitSide ( ) const

Get the side for which the modal split functions hold ( 1=Origin Side 2=Destination Side).

◆ getPurposes()

QVector< GKTripPurpose * > ModalSplitScenario::getPurposes ( ) const

Get used purposes.

◆ getUserDefinedSkim()

GKODMatrix * ModalSplitScenario::getUserDefinedSkim ( const GKODMatrix iTripMatrix,
const GKTransportationMode iMode,
const uint  iColumnIndex 
) const

Get the user-defined skim matrix for specific GKODMatrix trip matrix, GKTransportationMode and column index (the index starts at value 0 for the first user-defined column) *‍/.

◆ getUsers()

QVector< GKUserClass * > ModalSplitScenario::getUsers ( ) const

Get used user classes.

◆ getVehicles()

QVector< GKVehicle * > ModalSplitScenario::getVehicles ( ) const

Get used vehicle types.

◆ parkingSide()

Side ModalSplitScenario::parkingSide ( ) const

Get the side for which the parking costs and restrictions hold ( 1=Origin Side 2=Destination Side).

◆ removeComponentSkim()

void ModalSplitScenario::removeComponentSkim ( const GKODMatrix iTripMatrix,
const GKTransportationMode iMode,
const GKFunctionComponent iComponent 
)

Removes the user-defined skim matrix for specific GKODMatrix trip matrix, GKTransportationMode and GKFunctionComponent *‍/.

◆ removeTripMatrices()

void ModalSplitScenario::removeTripMatrices ( )

Remove Trip Matrices (GKODMatrix) from Scenario.

◆ removeUserDefinedSkim()

void ModalSplitScenario::removeUserDefinedSkim ( const GKODMatrix iTripMatrix,
const GKTransportationMode iMode,
const uint  iColumnIndex 
)

Removes the user-defined skim matrix for specific GKGenerationAttractionVector, GKTransportationMode and column index (the index starts at value 0 for the first user-defined column) *‍/.

◆ setCarAvailabilityDistinction()

void ModalSplitScenario::setCarAvailabilityDistinction ( int  iValue)

Set whether the modal split will consider Car Availability.

◆ setComponentSkim()

void ModalSplitScenario::setComponentSkim ( const GKODMatrix iTripMatrix,
const GKTransportationMode iMode,
const GKFunctionComponent iComponent,
GKODMatrix iSkim 
)

Set the user-defined skim matrix for specific GKODMatrix trip matrix, GKTransportationMode and GKFunctionComponent *‍/.

◆ setDataSet()

void ModalSplitScenario::setDataSet ( GKDistributionDataSet dataSet)

Set the Data Set in the scenario.

◆ setModalSplitSide()

void ModalSplitScenario::setModalSplitSide ( Side  side)

Set the side for which the modal split functions hold ( 1=Origin Side 2=Destination Side).

◆ setParkingSide()

void ModalSplitScenario::setParkingSide ( Side  side)

Set the side for which the parking costs and restrictions hold ( 1=Origin Side 2=Destination Side).

◆ setStoreResults()

void ModalSplitScenario::setStoreResults ( bool  value)

Set whether the Scenario stores results.

◆ setTimePeriod()

void ModalSplitScenario::setTimePeriod ( GKTimePeriod iTimePeriod)

Set the Time Period in the scenario. *‍/.

◆ setTripMatricesData()

void ModalSplitScenario::setTripMatricesData ( const ModalSplitTripMatricesUtil iTripMatricesData)

Set tripMatricesData.

◆ setUserDefinedSkim()

void ModalSplitScenario::setUserDefinedSkim ( const GKODMatrix iTripMatrix,
const GKTransportationMode iMode,
const uint  iColumnIndex,
GKODMatrix iSkim 
)

Set the user-defined skim matrix for specific GKODMatrix trip matrix, GKTransportationMode and column index (the index starts at value 0 for the first user-defined column) *‍/.

◆ storeResults()

bool ModalSplitScenario::storeResults ( ) const

Get whether the Scenario stores results.

◆ timePeriod()

GKTimePeriod * ModalSplitScenario::timePeriod ( ) const

Get the Time Period in the scenario. *‍/.

◆ tripMatricesData()

const ModalSplitTripMatricesUtil & ModalSplitScenario::tripMatricesData ( ) const

Get tripMatricesData.

© Aimsun SLU
Aimsun ®