|
Aimsun Next Scripting
22
|
Public Types | |
| enum | GKScenarioChangeType { eLaneClosing , eSpeedChange , eForceTurning , eDestinationChange , eIncident , eDemandModification , eTurningClosing , eControlPlanChange , ePeriodicIncident , eSectionBehaviouralParametersChange , eTurningBehaviouralParametersChange , eDisableReserved , eRoadPricing , eRoadPricingChange , eMeteringOnRampChange , eIntersectionPlanChange , eForceEnrouteAssignment , eTurningCooperation , eParkAndRideChange , eNone } |
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::IdentifierFormFlag > | IdentifierForm |
Public Member Functions | |
| GKScenarioChange () | |
| virtual GKScenarioChangeType | getChangeType () const =0 |
| virtual bool | canBeUsed (const GKExperiment *where, const QSet< GKGeoObject * > &inObjects) const |
| const QString & | getComplianceLevel () const |
| void | setComplianceLevel (const QString &value) |
| GKVehicleClass * | getVehicleClass () const |
| void | setVehicleClass (GKVehicleClass *vehClass) |
| const QString & | getMessage (GKVMS *vms) const |
| void | setMessage (GKVMS *vms, const QString &message) |
| void | removeMessage (GKVMS *vms) |
| void | clearMessages () |
| void | activateMessagesInVMS () const |
| void | deactivateMessagesInVMS () const |
| void | setPolicy (GKPolicy *apolicy) |
| GKPolicy * | getPolicy () 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 GKObject * | clone (bool addItToModel=true) const |
| virtual GKObject * | cloneAsTemporary (bool addItToModel=true) const |
| GKFolder * | getCreateRootFolder () |
| GKFolder * | getRootFolder () const |
| void | setRootFolder (GKFolder *afolder) |
| GKFolder * | findFolder (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 GKTimeSerie * | getDataValueTS (const GKColumn *attr) const |
| GKTimeSerie * | getDataValueTSByID (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 GKObject * | getDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const |
| GKObject * | getDataValueObjectByID (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 GKObject * | getMaster () const |
| GKType * | getType () const |
| virtual void | setType (GKType *atype) |
| bool | isA (const GKType *atype) const |
| bool | isA (const QString &typeName) const |
| virtual void | setModel (GKModel *amodel) |
| GKModel * | getModel () 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 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 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 |
A Scenario Change is a change in the simulation conditions (lane closure, speed modification) that is not pressent always in the network (if its always present it will be coded directly on it).
A change is part of a GKPolicy or a GKTrafficCondition and is applied when these classes say so.
| GKScenarioChange::GKScenarioChange | ( | ) |
| void GKScenarioChange::activateMessagesInVMS | ( | ) | const |
Someone has activate this change. This method will set the messages on the VMS.
|
virtual |
Returns true if this Scenario changed can be used in an experiment simulation. It will check:
| void GKScenarioChange::clearMessages | ( | ) |
Removes all the messages.
| void GKScenarioChange::deactivateMessagesInVMS | ( | ) | const |
Someone has deactivate this change. This method will remove the messages on the VMS.
|
pure virtual |
returns the change type associated with the class
Implemented in GKControlPlanChange, GKDestinationChange, GKDisableReservedLaneChange, GKForceEnrouteAssignment, GKForceTurning, GKLaneClosingChange, GKParkAndRideChange, GKRoadPricing, GKSectionBehaviouralParametersChange, GKSectionIncident, GKSpeedChange, GKTurningBehaviouralParametersChange, GKTurningClosingChange, and GKTurningCooperationChange.
| const QString & GKScenarioChange::getComplianceLevel | ( | ) | const |
Returns the compliance level (a percentage: [0,100] ) as a string (as it can be a variable)
| const QString & GKScenarioChange::getMessage | ( | GKVMS * | vms | ) | const |
Gets the message for the vms.
| GKPolicy * GKScenarioChange::getPolicy | ( | ) | const |
Returns the policy in where this change is.
| GKVehicleClass * GKScenarioChange::getVehicleClass | ( | ) | const |
Returns the vehicle class affected by this change. A None means that all the classes are affected.
| void GKScenarioChange::removeMessage | ( | GKVMS * | vms | ) |
Removes the message, if any, associated with a vms.
| void GKScenarioChange::setComplianceLevel | ( | const QString & | value | ) |
Sets the compliance level percentage. It can be a variable.
| void GKScenarioChange::setMessage | ( | GKVMS * | vms, |
| const QString & | message | ||
| ) |
Sets the message for the vms.
| void GKScenarioChange::setPolicy | ( | GKPolicy * | apolicy | ) |
Sets the policy in where this change is.
| void GKScenarioChange::setVehicleClass | ( | GKVehicleClass * | vehClass | ) |
Sets which vehicle class is affected by this change. A None means that all the classes are affected.
1.9.4