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

Public Member Functions

 GKPedestrianCrossing ()
 
GKNodegetNode () const
 
bool isAtTheEnd () const
 
bool isAtTheBeginning () const
 
void setSafetyMarginFront (float margin)
 
float getSafetyMarginFront () const
 
void setSafetyMarginBack (float margin)
 
float getSafetyMarginBack () const
 
void setConsiderAsYellowBox (bool value)
 
bool getConsiderAsYellowBox () const
 
void setGiveWayToVehiclesBefore (bool value)
 
bool getGiveWayToVehiclesBefore () const
 
bool isSignalized (const GKMasterControlPlan *masterPlan) const
 
const GKPointsgetLeftWaitingArea ()
 
const GKPointsgetRightWaitingArea ()
 
void setRightWaitingArea (const GKPoints &points)
 
void setLeftWaitingArea (const GKPoints &points)
 
void rebuildWaitingAreas ()
 
bool isShowingWaitingAreas () const
 
bool isLeftWaitingAreaActive () const
 
bool isRightWaitingAreaActive () const
 
- Public Member Functions inherited from GKSectionObject
 GKSectionObject ()
 
void setLanes (uint fromLane, uint toLane)
 
void setPosition (double pos)
 
void setLength (double length)
 
double getPosition () const
 
double getLength () const
 
uint getFromLane () const
 
uint getToLane () const
 
GKSectiongetSection () const
 
virtual bool oneLane ()
 
virtual bool manyLanes ()
 
virtual bool allLanes ()
 
virtual bool fixedWidth ()
 
virtual bool canBePlacedOutside ()
 
virtual bool fixedLane ()
 
void directTranslate (const GKPoint &)
 
float translatePosition (const GKPoint &) const
 
bool adjust ()
 
GKPoint absolutePosition () const
 
GKPoint absolutePositionInLanes () 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
 

Static Public Attributes

static uint safetyMarginAtt
 
- Static Public Attributes inherited from GKSectionObject
static uint posAtt
 
static uint sectionAtt
 
static uint lengthAtt
 
- 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
 

Additional Inherited Members

- 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
 
- Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObjectbase = (GKBaseObject*)sipCpp
 
 sipType = 0
 

Detailed Description

A pedestrian crossing that can be set at the beginning or end of a section. For crossings in the middle in a node (Japanese style) use decorated turns.

Constructor & Destructor Documentation

◆ GKPedestrianCrossing()

GKPedestrianCrossing::GKPedestrianCrossing ( )

Member Function Documentation

◆ getConsiderAsYellowBox()

bool GKPedestrianCrossing::getConsiderAsYellowBox ( ) const

Gets whether this pedestrian crossing will be considered as yellow box or not.

◆ getGiveWayToVehiclesBefore()

bool GKPedestrianCrossing::getGiveWayToVehiclesBefore ( ) const

Gets whether vehicles will halt at the stop line (true) or at the end of the section, meaning they enter and wait on the crossing (false).

◆ getLeftWaitingArea()

const GKPoints & GKPedestrianCrossing::getLeftWaitingArea ( )

Returns the waiting area at left. If it does not exist, it creates the waiting area with width equal to section lane width.

◆ getNode()

GKNode * GKPedestrianCrossing::getNode ( ) const

Returns the node this pedestrian crossing affects to, that is, the section's origin node when located at the beginning of the section and the section's destination node when located at the end

◆ getRightWaitingArea()

const GKPoints & GKPedestrianCrossing::getRightWaitingArea ( )

Returns the waiting area at right. If it does not exist, it creates the waiting area with width equal to section lane width.

◆ getSafetyMarginBack()

float GKPedestrianCrossing::getSafetyMarginBack ( ) const

Safety margin (in m) to apply to a pedestrian back. 3 m by default.

◆ getSafetyMarginFront()

float GKPedestrianCrossing::getSafetyMarginFront ( ) const

Safety margin (in m) to apply to a pedestrian front. 3 m by default.

◆ isAtTheBeginning()

bool GKPedestrianCrossing::isAtTheBeginning ( ) const

Is this pedestrian crossing at the beginning?

◆ isAtTheEnd()

bool GKPedestrianCrossing::isAtTheEnd ( ) const

Is this pedestrian crossing at the end?

◆ isLeftWaitingAreaActive()

bool GKPedestrianCrossing::isLeftWaitingAreaActive ( ) const

Returns whether the LEFT waiting area is active or not. They are only visible when the pedestrian crossing is inside a pedestrian area

◆ isRightWaitingAreaActive()

bool GKPedestrianCrossing::isRightWaitingAreaActive ( ) const

Returns whether the RIGHT waiting area is active or not. They are only visible when the pedestrian crossing is inside a pedestrian area

◆ isShowingWaitingAreas()

bool GKPedestrianCrossing::isShowingWaitingAreas ( ) const

Returns whether the waiting areas are visible or not. They are only visible when the pedestrian crossing is inside a pedestrian area

◆ isSignalized()

bool GKPedestrianCrossing::isSignalized ( const GKMasterControlPlan masterPlan) const

Returns true if the pedestrian crossing is signalised in the masterPlan. False, otherwise. Pedestrian crossings can only be in signal groups belonging to either section's origin node or section's destination node

◆ rebuildWaitingAreas()

void GKPedestrianCrossing::rebuildWaitingAreas ( )

◆ setConsiderAsYellowBox()

void GKPedestrianCrossing::setConsiderAsYellowBox ( bool  value)

Sets this pedestrian crossing to be considered as yellow box or not.

◆ setGiveWayToVehiclesBefore()

void GKPedestrianCrossing::setGiveWayToVehiclesBefore ( bool  value)

Sets whether vehicles will halt at the stop line (true) or at the end of the section, meaning they enter and wait on the crossing (false).

◆ setLeftWaitingArea()

void GKPedestrianCrossing::setLeftWaitingArea ( const GKPoints points)

Sets the left waiting area points

◆ setRightWaitingArea()

void GKPedestrianCrossing::setRightWaitingArea ( const GKPoints points)

Sets the right waiting area points

◆ setSafetyMarginBack()

void GKPedestrianCrossing::setSafetyMarginBack ( float  margin)

Safety margin (in m) to apply to a pedestrian back. 3 m by default.

◆ setSafetyMarginFront()

void GKPedestrianCrossing::setSafetyMarginFront ( float  margin)

Safety margin (in m) to apply to a pedestrian front. 3 m by default.

Member Data Documentation

◆ safetyMarginAtt

uint GKPedestrianCrossing::safetyMarginAtt
static

Safety margin (in m) to apply to a pedestrian, both in front and back (so is a radius, no a diameter). 3 m by default.

© Aimsun SLU
Aimsun ®