Aimsun Next Scripting  22
Public Member Functions | Public Attributes | List of all members
GKSimulationArea Class Reference
Inheritance diagram for GKSimulationArea:
GKPolygon GKPolyline GKGeoObject GKObject GKBaseObject

Public Member Functions

 GKSimulationArea ()
 
void useManualSections (bool value)
 
bool usingManualSections () const
 
QVector< GKSection * > getManualSections () const
 
sipCpp apply ([&sections](GKSection *section){ sections->push_back(section);})
 
End void setManualSections (const QVector< GKSection * > &sections)
 
void addManualSection (GKSection *section)
 
void removeManualSection (GKSection *section)
 
bool containsManualSection (const GKSection *section) const
 
QSet< GKGeoObject * > classifyObjectsByPolygon (GKLayer *layer=NULL) const
 
QSet< GKGeoObject * > classifyObjectsByManualSections (GKLayer *layer=NULL) const
 
bool containsObject (const GKGeoObject *obj) const
 
void count ()
 
uint getNbSections () const
 
uint getNbNodes () const
 
uint getNbAllNodes () const
 
void calculateGates (const GKTrafficDemand *trafficDemand, qint32 scenarioId)
 
const QMap< int, GKSection * > & getEntranceGates () const
 
const QMap< int, GKSection * > & getExitGates () const
 
- Public Member Functions inherited from GKPolygon
 GKPolygon ()
 
void setBrushColor (const QColor &color)
 
const QColor & getBrushColor () const
 
void setBrushStyle (const Qt::BrushStyle &astyle)
 
virtual GKGeoContainer doGetContainedWay (const GKBBox &myBBox, const GKPoints &points, const GKBBox &bboxPoints) const
 
bool isFilled () const
 
void setTopTexture (const QString &textureName, int horizontalReps, int verticalReps)
 
const GKTextureAppliedgetTopTexture () const
 
void setBottomTexture (const QString &textureName, int horizontalReps, int verticalReps)
 
const GKTextureAppliedgetBottomTexture () const
 
QSet< GKGeoObject * > classifyObjects (qint32 scenarioId, GKObjectsClassification objsToClassify, GKLayer *layer=NULL) const
 
QSet< GKGeoObject * > classifyObjects (qint32 scenarioId) const
 
QSet< GKGeoObject * > classifyObjectsInside (qint32 scenarioId, GKLayer *layer=NULL) const
 
QSet< GKGeoObject * > classifyObjectsPartiallyInside (qint32 scenarioId, GKLayer *layer=NULL) const
 
- Public Member Functions inherited from GKPolyline
 GKPolyline ()
 
uint nbPoints () const
 
const GKPointgetPoint (uint at) const
 
void setPoint (uint at, const GKPoint &p)
 
const GKPointsgetPoints () const
 
virtual void addPoint (const GKPoint &p)
 
virtual void addPointAt (int pos, const GKPoint &p)
 
virtual void removePoint (uint pos)
 
virtual void setPoints (const GKPoints &ps)
 
virtual GKCoord length2D () const
 
virtual GKCoord length3D () const
 
virtual bool canPointBeAdded (uint pos) const
 
virtual void join (const GKPolyline *pol, bool atStart)
 
virtual void removePoints (uint nbPoints, bool atStart)
 
virtual bool canBeJoined (const GKPolyline *pol) const
 
void prepend (const GKPoints &ps)
 
void add (const GKPoints &ps)
 
void setPointSelected (uint p, bool value)
 
bool isPointSelected (uint p) const
 
void selectAllPoints ()
 
void unselectAllPoints ()
 
int getNbSelPoints () const
 
virtual void changeDirection ()
 
GKCoord getSlope (int segmentPos) const
 
GKBBox getBBox () const
 
void setPenColor (const QColor &color)
 
virtual const QColor & getPenColor () const
 
void setPenStyle (const Qt::PenStyle &astyle)
 
const Qt::PenStyle & getPenStyle () const
 
void setPenSize (float size)
 
float getPenSize () const
 
void setPenSizeUnits (const GK::SizeUnits &units)
 
const GK::SizeUnitsgetPenSizeUnits () const
 
- Public Member Functions inherited from GKGeoObject
 GKGeoObject ()
 
virtual void setSelected (bool newState)
 
virtual bool isSelected () const
 
bool canBeModified () const
 
bool canBeEdited () const
 
virtual bool canBeGrouped () const
 
int getMark () const
 
void setMark (int newMark)
 
void addMark (int newMark)
 
void unmark ()
 
const QVector< int > * getMarks () const
 
uint getNumberOfMarks () const
 
GKLayergetLayer () const
 
void setLayer (GKLayer *alayer)
 
virtual void translate (const GKPoint &delta)
 
virtual void rotate (const GKPoint &center, double angle)
 
virtual void scale (const GKPoint &)
 
virtual GKCoord getAltitude () const
 
virtual void setAltitude (GKCoord value)
 
void addTopObject (GKGeoObject *)
 
QSet< GKGeoObject * > * getTopObjects () const
 
GKGeoObjectgetBottomObject () const
 
void setLabeled (bool value)
 
bool isLabeled () const
 
GKGeoContainer getContainedWay (const GKPoints &points, const GKBBox &bboxPoints) const
 
virtual GKGeoContainer doGetContainedWay (const GKBBox &myBBox, const GKPoints &points, const GKBBox &bboxPoints) const
 
GK::ConnectionType objectConnectionType (const GKGeoObject *object) const
 
QSet< GKObjectConnection * > getConnections () const
 
QSet< GKObjectConnection * > getConnections (const GKGeoObject *) const
 
bool anyConnection (const GKGeoObject *) const
 
virtual void addConnection (GKObjectConnection *)
 
virtual void removeConnection (GKObjectConnection *, GK::ObjectDeletionBehaviour)
 
virtual void changeConnectionObject (GKGeoObject *oldObject, GKGeoObject *newObject, GK::ConnectionType connectionType=GK::eConnectionUndefined)
 
virtual void removeAllConnections (GK::ObjectDeletionBehaviour)
 
virtual bool acceptConnection (GKGeoObject *object) const
 
virtual GKGeoObjectCutCmd * getCutCmd (const GKPoint &from, const GKPoint &to, bool keepConnection)
 
virtual bool exists (quint32 scenarioId) 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
 

Public Attributes

MethodCode QVector< GKSection * > * sections = new QVector<GKSection*>()
 
 sipRes = sections
 
- Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObjectbase = (GKBaseObject*)sipCpp
 
 sipType = 0
 

Additional Inherited Members

- Public Types inherited from GKPolygon
enum  GKObjectsClassification { eAll , eOnlyNodesAndSections }
 
- Public Types inherited from GKGeoObject
enum  GKGeoContainer { eNothing = 0 , ePartially = 1 , eTotally = 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
 
- Static Public Attributes inherited from GKGeoObject
static uint markAtt
 
static uint altitudeAtt
 
static uint numberOfConnectionsAtt
 
static uint layerAtt
 
- 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
 

Detailed Description

Defines a sub-area of the network which will be simulated in micro mode, inside a Hybrid Meso-Micro experiment, or in meso mode, inside a Hybrid Macro-Meso experiment. As GKProblemNet, the object can specify either a polygon which embraces the sections and nodes to be micro-simulated or meso-simulated respectively, or either as a simple list of sections.

Constructor & Destructor Documentation

◆ GKSimulationArea()

GKSimulationArea::GKSimulationArea ( )

Member Function Documentation

◆ addManualSection()

void GKSimulationArea::addManualSection ( GKSection section)

Adds a section to the list of manual sections

◆ apply()

sipCpp GKSimulationArea::apply ( [&sections] (GKSection *section){ sections->push_back(section);}  )

References sections.

◆ calculateGates()

void GKSimulationArea::calculateGates ( const GKTrafficDemand trafficDemand,
qint32  scenarioId 
)

Calculate the entrance and exit gates for the area.

◆ classifyObjectsByManualSections()

QSet< GKGeoObject * > GKSimulationArea::classifyObjectsByManualSections ( GKLayer layer = NULL) const

Filters the model by using the given section list. The objects are filtered out by using the following criteria:

  • sections in the list belongs to the simulation area
  • ending nodes of any section inside the simulation area also belongs to the it
  • any section ending on a node inside the simulation area also belongs to it
Parameters
layer: if not NULL, then only the objects belonging to that layer will be returned.

◆ classifyObjectsByPolygon()

QSet< GKGeoObject * > GKSimulationArea::classifyObjectsByPolygon ( GKLayer layer = NULL) const

Filters the geo model, using the polygon which defines the simulation area. The objects are filtered out by using the following criteria:

  • if a node is inside the area, then any section ending on that node belongs to it.
  • if a section completely fits into the area, then it also belongs to it.
Parameters
layer: if not NULL, then only the objects belonging to that layer will be returned.

◆ containsManualSection()

bool GKSimulationArea::containsManualSection ( const GKSection section) const

Returns true if the section is in the list of manual sections

◆ containsObject()

bool GKSimulationArea::containsObject ( const GKGeoObject obj) const

Returns true if the given object belongs to the simulation area, according to the current area parameters.

◆ count()

void GKSimulationArea::count ( )

Counts the number of sections and nodes on this simulation area (using GKSimulationArea::classifyObjects ). After counting, this information can be read using GKSimulationArea::getNbSections and GKSimulationArea::getNbNodes

◆ getEntranceGates()

const QMap< int, GKSection * > & GKSimulationArea::getEntranceGates ( ) const

Returns a map with all the sections that are considered entrance gates because they are in the borders of the simulation area. The key of the map is the section id and the data the section itself

◆ getExitGates()

const QMap< int, GKSection * > & GKSimulationArea::getExitGates ( ) const

Returns a map with all the sections that are considered exit gates because they are in the borders of the simulation area. The key of the map is the section id and the data the section itself

◆ getManualSections()

QVector< GKSection * > GKSimulationArea::getManualSections ( ) const

The list of sections to use in this subnetwork.

◆ getNbAllNodes()

uint GKSimulationArea::getNbAllNodes ( ) const

Returns the number of nodes on this simulation area. A node is counted if it is totally or partially inside. Call GKSimulationArea::count before calling this method.

◆ getNbNodes()

uint GKSimulationArea::getNbNodes ( ) const

Returns the number of nodes on this simulation area with more than one turn. A node is counted if it is totally or partially inside. Call GKSimulationArea::count before calling this method.

◆ getNbSections()

uint GKSimulationArea::getNbSections ( ) const

Returns the number of sections on this simulation area. A section is counted if it is totally or partially inside. Call GKSimulationArea::count before calling this method.

◆ removeManualSection()

void GKSimulationArea::removeManualSection ( GKSection section)

Removed a section to the list of manual sections

Warning
The specified section MUST be contained in the list of manual sections.

◆ setManualSections()

End void GKSimulationArea::setManualSections ( const QVector< GKSection * > &  sections)

The list of sections to use in this subnetwork.

◆ useManualSections()

void GKSimulationArea::useManualSections ( bool  value)

True if we will consider a list of sections set by the user, false (the default) if we consider sections in the polygon.

◆ usingManualSections()

bool GKSimulationArea::usingManualSections ( ) const

True if we will consider a list of sections set by the user, false (the default) if we consider sections in the polygon.

Member Data Documentation

◆ sections

MethodCode QVector<GKSection*>* GKSimulationArea::sections = new QVector<GKSection*>()

Referenced by apply().

◆ sipRes

GKSimulationArea::sipRes = sections

© Aimsun SLU
Aimsun ®