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

Public Member Functions

 GKMetering ()
 
uint getVehFlow () const
 
void setVehFlow (uint vehs)
 
const QMap< int, GKDetector * > & getDownstreamDetectors () const
 
void setDownstreamDetectors (QMap< int, GKDetector * > &downDet)
 
void addDownstreamDetector (GKDetector *downDet)
 
void removeDownstreamDetector (GKDetector *downDet)
 
void clearDownstreamDetectors ()
 
const QMap< int, GKDetector * > & getLinkEntranceDetectors () const
 
void setLinkEntranceDetectors (const QMap< int, GKDetector * > &aLinkEntranceDetectors)
 
void addLinkEntranceDetector (GKDetector *aLinkEntranceDet)
 
void removeLinkEntranceDetector (GKDetector *aLinkEntranceDet)
 
void clearLinkEntranceDetectors ()
 
const QMap< int, GKDetector * > & getMidLinkDetectors () const
 
void setMidLinkDetectors (const QMap< int, GKDetector * > &aMidLinkDetectors)
 
void addMidLinkDetector (GKDetector *aMidLinkDet)
 
void removeMidLinkDetector (GKDetector *aMidLinkDet)
 
void clearMidLinkDetectors ()
 
const QMap< int, GKDetector * > & getLinkExitDetectors () const
 
void setLinkExitDetectors (const QMap< int, GKDetector * > &aLinkExitDetectors)
 
void addLinkExitDetector (GKDetector *aLinkExitDetect)
 
void removeLinkExitDetector (GKDetector *aLinkExitDetect)
 
void clearLinkExitDetectors ()
 
double getKalmanSinglePointCorrection () const
 
void setKalmanSinglePointCorrection (double aKalmanSinglePointCorrection)
 
- 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 GKGeoObjectCutCmdgetCutCmd (const GKPoint &from, const GKPoint &to, bool keepConnection)
 
virtual bool exists (const GKGenericScenario *scenario) 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, bool temporary=false) const
 
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, unsigned int index, double *deviation=nullptr) const
 
double getDataValueInTSByID (uint attrId, unsigned int index, double *deviation=nullptr) const
 
bool hasAnyTSWithData () const
 
virtual GKTimeSerie * getDataValueTS (const GKColumn *attr) const
 
GKTimeSerie * getDataValueTSByID (uint attrId) const
 
virtual void setDataValueInTS (const GKColumn *attr, unsigned int index, double value, double deviation, GKTSDescription *aDescription=nullptr)
 
virtual void setDataValueInTS (const GKColumn *attr, unsigned int index, double value, double deviation, double lowerValue, GKTSDescription *aDescription=nullptr)
 
void setDataValueInTSByID (uint attrId, unsigned int index, double value, double deviation, GKTSDescription *aDescription=nullptr)
 
void setDataValueInExpandableTSByID (uint attrId, double value, double deviation, GKTSDescription *aDescription=nullptr)
 
virtual void setAggregatedValueInTS (const GKColumn *attr, double value, double deviation, GKTSDescription *aDescription=NULL)
 
void setAggregatedValueInTSByID (uint attrId, double value, double deviation, GKTSDescription *aDescription=NULL)
 
GKTimeSerie * createDataValueTS (const GKColumn *attr, GKTSDescription *aDescription)
 
virtual void clearDataValueTS (const GKColumn *attr)
 
void clearDataValueTSByID (uint attrId)
 
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 GKObjectDelCmdgetDelCmd ()
 
virtual GKObjectConnectionDelCmdgetDelConnectionCmd (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, unsigned int index, double *deviation=NULL) const =0
 
virtual double getDataValueInTSByID (uint attrId, unsigned int index, double *deviation=nullptr) 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 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 typeAtt
 
- 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

Ramp Meter takes place on entrance ramps to a freeway in order to limit the flow of vehicles entering, thus ensuring a non-congested flow on the freeway itself

Use the GKSectionObjectNewCmd class to create new meterings.

Constructor & Destructor Documentation

◆ GKMetering()

GKMetering::GKMetering ( )

Member Function Documentation

◆ addDownstreamDetector()

void GKMetering::addDownstreamDetector ( GKDetector downDet)

On Flow-ALINEA meterings, adds a downstream detectors to consider.

◆ addLinkEntranceDetector()

void GKMetering::addLinkEntranceDetector ( GKDetector aLinkEntranceDet)

On Flow-HERO meterings (extension),Adds a link entrance detector to consider.

◆ addLinkExitDetector()

void GKMetering::addLinkExitDetector ( GKDetector aLinkExitDetect)

On Flow-HERO meterings (extension),Adds a link exit detector to consider.

◆ addMidLinkDetector()

void GKMetering::addMidLinkDetector ( GKDetector aMidLinkDet)

On Flow-HERO meterings (extension),Adds a mid link detector to consider.

◆ clearDownstreamDetectors()

void GKMetering::clearDownstreamDetectors ( )

On Flow-ALINEA meterings, clears the downstream detectors to consider.

◆ clearLinkEntranceDetectors()

void GKMetering::clearLinkEntranceDetectors ( )

On Flow-HERO meterings (extension),Clears the link entrance detectors to consider.

◆ clearLinkExitDetectors()

void GKMetering::clearLinkExitDetectors ( )

On Flow-HERO meterings (extension),Clears the link exit detectors to consider.

◆ clearMidLinkDetectors()

void GKMetering::clearMidLinkDetectors ( )

On Flow-HERO meterings (extension), Clears the mid link detectors to consider.

◆ getDownstreamDetectors()

const QMap< int, GKDetector * > & GKMetering::getDownstreamDetectors ( ) const

On Flow-ALINEA meterings, returns the downstream detectors defined.

◆ getKalmanSinglePointCorrection()

double GKMetering::getKalmanSinglePointCorrection ( ) const

On Flow-HERO meterings (extension),Returns Kalman Single Point Correction Factor defined.

◆ getLinkEntranceDetectors()

const QMap< int, GKDetector * > & GKMetering::getLinkEntranceDetectors ( ) const

On Flow-HERO meterings (extension), Returns the link entrance detectors defined.

◆ getLinkExitDetectors()

const QMap< int, GKDetector * > & GKMetering::getLinkExitDetectors ( ) const

On Flow-HERO meterings (extension),Returns the link exit detectors defined.

◆ getMidLinkDetectors()

const QMap< int, GKDetector * > & GKMetering::getMidLinkDetectors ( ) const

On Flow-HERO meterings (extension), Returns the mid link detectors defined.

◆ getVehFlow()

uint GKMetering::getVehFlow ( ) const

On Flow meterings, returns the maximum platoon of vehicles that can pass through the signal.

◆ removeDownstreamDetector()

void GKMetering::removeDownstreamDetector ( GKDetector downDet)

On Flow-ALINEA meterings, removes the downDet from the downstream detectors to consider.

◆ removeLinkEntranceDetector()

void GKMetering::removeLinkEntranceDetector ( GKDetector aLinkEntranceDet)

On Flow-HERO meterings (extension),Removes the link entrance detector from the link entrance detectors to consider.

◆ removeLinkExitDetector()

void GKMetering::removeLinkExitDetector ( GKDetector aLinkExitDetect)

On Flow-HERO meterings (extension),Removes the link exit detector from the link exit detectors to consider.

◆ removeMidLinkDetector()

void GKMetering::removeMidLinkDetector ( GKDetector aMidLinkDet)

On Flow-HERO meterings (extension), Removes the mid link detector from the mid link detector to consider.

◆ setDownstreamDetectors()

void GKMetering::setDownstreamDetectors ( QMap< int, GKDetector * > &  downDet)

On Flow-ALINEA meterings, sets the downstream detectors to consider.

◆ setKalmanSinglePointCorrection()

void GKMetering::setKalmanSinglePointCorrection ( double  aKalmanSinglePointCorrection)

On Flow-HERO meterings (extension),Sets Kalman Single Point Correction Factor defined.

◆ setLinkEntranceDetectors()

void GKMetering::setLinkEntranceDetectors ( const QMap< int, GKDetector * > &  aLinkEntranceDetectors)

On Flow-HERO meterings (extension),Sets the link entrance detectors to consider.

◆ setLinkExitDetectors()

void GKMetering::setLinkExitDetectors ( const QMap< int, GKDetector * > &  aLinkExitDetectors)

On Flow-HERO meterings (extension),Sets the link exit detectors to consider.

◆ setMidLinkDetectors()

void GKMetering::setMidLinkDetectors ( const QMap< int, GKDetector * > &  aMidLinkDetectors)

On Flow-HERO meterings (extension),Sets the mid link detectors to consider.

◆ setVehFlow()

void GKMetering::setVehFlow ( uint  vehs)

On Flow meterings, sets the maximum platoon of vehicles that can pass through the signal.

Member Data Documentation

◆ typeAtt

uint GKMetering::typeAtt
static

type = 0 -> Green Time, 1 -> Flow, 2 -> Delay, 3 -> Flow-ALINEA, 4 -> Green Time by Lane

© Aimsun SLU
Aimsun ®