Aimsun Next Scripting: GKTurning Class Reference
Aimsun Next Scripting  22
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
GKTurning Class Reference
Inheritance diagram for GKTurning:
GKBezierCurve GKPolyline GKGeoObject GKObject GKBaseObject

Public Types

enum  GKWarningIndicator { eNone = 0 , eGiveway = 1 , eStop = 2 , eRTOR = 3 }
 
- Public Types inherited from GKBezierCurve
enum  GKBezierCurveType { eSegment = 0 , eSimpleCurve = 1 , eCurve = 2 }
 
- 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 Member Functions

 GKTurning ()
 
bool canUse (GKVehicleClass *)
 
GKNodegetNode () const
 
void setNode (GKNode *)
 
virtual void setOrigin (GKSection *)
 
virtual void setDestination (GKSection *)
 
GKSectiongetOrigin () const
 
GKSectiongetDestination () const
 
virtual void setConnection (GKSection *, GKSection *)
 
void updatePath (bool)
 
void setOriginLanes (uint, uint)
 
void setDestinationLanes (uint, uint)
 
uint getOriginFromLane () const
 
uint getDestinationFromLane () const
 
uint getOriginToLane () const
 
uint getDestinationToLane () const
 
void setSpeed (double)
 
void addTurningEntity (const GKTurningEntity &_turningEntity)
 
void setTurningEntitiesProps (unsigned short _of, unsigned short _ot, unsigned short _df, unsigned short _dt)
 
const GKTurningEntitiesgetTurningEntities () const
 
void clearTurningEntities ()
 
double getSpeed () const
 
void addStopLine (GKStopLine stopLine)
 
void removeStopLine (GKStopLine stopLine)
 
void removeAllStopLines ()
 
const QVector< GKStopLine > & getStopLines () const
 
void setStopLinePosition (int p, double position)
 
void setStopLineLength (int p, double length)
 
double getStopLineByPoint (const GKPoint &p) const
 
double getReactionTimeFactor () const
 
void setReactionTimeFactor (double reactionTimeFactor)
 
GKFunctionCostgetInitialFunction () const
 
GKFunctionCostgetKInitialsFunction () const
 
GKFunctionCostgetDynamicFunction () const
 
void setInitialFunction (GKFunctionCost *fc)
 
void setKInitialsFunction (GKFunctionCost *fc)
 
void setDynamicFunction (GKFunctionCost *fc)
 
const GKFunctionCostgetTurnPenaltyFunction () const
 
const GKFunctionCostgetJunctionDelayFunction () const
 
void setTurnPenaltyFunction (const GKFunctionCost *fc)
 
void setJunctionDelayFunction (const GKFunctionCost *fc)
 
double calculateSpeed ()
 
bool isAutoSpeed () const
 
void setAutoSpeed (bool)
 
void setCapacity (double value)
 
double getCapacity () const
 
double capacity () const
 
End void setAutomaticCapacity (bool value)
 
bool automaticCapacity () const
 
void setUseCapacityAsAttractiveness (bool value)
 
bool useCapacityAsAttractiveness () const
 
void setAttractiveness (double value)
 
double attractiveness () const
 
void setWarningIndicator (GKWarningIndicator)
 
GKWarningIndicator getWarningIndicator () const
 
GKPoints getPolygon () const
 
void translatedByNode (const GKPoint &)
 
bool canPointBeAdded (uint) const
 
void curve ()
 
bool isInternalRoundaboutTurning () const
 
void setInternalRoundaboutTurning (bool value)
 
double getUserDefinedCost () const
 
double getUserDefinedCost2 () const
 
double getUserDefinedCost3 () const
 
double getAdditionalVolume () const
 
void setUseRoadTypeDistanceZones (bool value)
 
bool isUsingRoadTypeDistanceZones () const
 
double calcAngleSections () const
 
double calcAngleBridge () const
 
- Public Member Functions inherited from GKBezierCurve
 GKBezierCurve ()
 
void addSegment (GKBezierCurveType type)
 
void setPoint (int s, int i, const GKPoint &p)
 
void setPoint (int i, const GKPoint &p)
 
void setCurve (const GKBezierCurve &curve)
 
void setFromSegment (const GKPoint &p1, const GKPoint &p2, GKBezierCurveType type)
 
void setFromPoints (const GKPoints &ps, GKBezierCurveType type)
 
uint getNbSegments () const
 
virtual void addCurvePointAt (int pos, const GKPoint &p)
 
virtual void removePoint (uint pos)
 
virtual bool canPointBeAdded (uint pos) const
 
GKPoints calculatePolyline (uint nbpoints=0, bool simplify=true, QVector< int > *segmentsBeginPos=NULL) const
 
bool isASegment () const
 
bool onlyContainsSegments () const
 
GKBezierCurveType getCurveType (uint pos) const
 
GKCoord length2D (uint nbpoints=0) const
 
GKCoord length3D (uint nbpoints=0) const
 
GKCoord getSegmentLength (uint pos, uint nbpoints=0) const
 
GKBezierCurve getSegment (uint pos) const
 
int getNumSegmentControlPoints (int pos) const
 
GKPoint calculateBezierPoint (float t) const
 
GKVector calculateBezierDerivative (float t) const
 
GKVector calculateBezierSecondDerivative (float t) const
 
GKCoord calculateBezierRadius (const GKPoints &p, uint nbpoints=0) const
 
GKCoord getBezierRadiusatPoint (const GKPoints &p, const GKPoint &p1, uint nbpoints=0) const
 
GKCoord MeanRadius (uint nbpoints=0) const
 
bool hit (const GKPoint &p, float epsilon) const
 
virtual void changeDirection ()
 
virtual void join (const GKPolyline *pol, bool atStart)
 
virtual void removePoints (uint nbPoints, bool atStart, int &nbSegmentsRemoved)
 
GKPoint pointAtPos (float pos) const
 
float posAtPoint (const GKPoint &p, GKCoord maxDistToCurve=0.01) const
 
int segmentAtPos (GKCoord pos, double *length=NULL) const
 
int segmentAtPosComplete (const GKPoints &points, GKCoord pos, double *retLength=NULL) const
 
uint nbParts () const
 
GKCoord angleToCurve (const GKBezierCurve &curve) const
 
virtual GKCoord getAltitude () const
 
virtual void setAltitude (GKCoord value)
 
- 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 sipRes = sipCpp ->getCapacity()
 
- Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObjectbase = (GKBaseObject*)sipCpp
 
 sipType = 0
 

Static Public Attributes

static uint originSectionAtt
 
static uint destinationSectionAtt
 
static uint autoSpeedAtt
 
static uint speedAtt
 
static uint yellowBoxBehaviourAtt
 
static uint warningAtt
 
static uint stopLineDistanceAtt
 
static uint kInitialsFunctionAtt
 
static uint initialFunctionAtt
 
static uint dynamicFunctionAtt
 
static uint nodeAtt
 
static uint reactionTimeFactorAtt
 
- 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

It connects some (or all) lanes between two sections.

Member Enumeration Documentation

◆ GKWarningIndicator

Warning indicator

Enumerator
eNone 
eGiveway 
eStop 
eRTOR 

Constructor & Destructor Documentation

◆ GKTurning()

GKTurning::GKTurning ( )

Member Function Documentation

◆ addStopLine()

void GKTurning::addStopLine ( GKStopLine  stopLine)

Sets the stop line distance relative to the start of the turn (in m)

◆ addTurningEntity()

void GKTurning::addTurningEntity ( const GKTurningEntity _turningEntity)

Adds a turn entity to the turn

◆ attractiveness()

double GKTurning::attractiveness ( ) const

Gets the turn attractiveness

◆ automaticCapacity()

bool GKTurning::automaticCapacity ( ) const

If true (the default) the capacity is calculated automatically. Otherwise, is defined by the user.

◆ calcAngleBridge()

double GKTurning::calcAngleBridge ( ) const

Returns the angle, in degrees, between the last segment of the origin section and the turn line. When going clockwise the angle will be negative and when going counterclockwise the angle will be positive

◆ calcAngleSections()

double GKTurning::calcAngleSections ( ) const

Returns the angle, in degrees, between the last segment of the origin section and the first segment of the destination section. When going clockwise the angle will be negative and when going counterclockwise the angle will be positive

◆ calculateSpeed()

double GKTurning::calculateSpeed ( )

Calculates automatically the turn speed based on the turn geometry and the sections involved.

◆ canPointBeAdded()

bool GKTurning::canPointBeAdded ( uint  ) const
virtual

Points at the end now allowed...

Reimplemented from GKBezierCurve.

◆ canUse()

bool GKTurning::canUse ( GKVehicleClass )

Returns true if this vehicle class can use this turn. It looks at the lanes involved in the turn, both in the origin and the destination sections, to see if they are reserved and cannot be used.

◆ capacity()

double GKTurning::capacity ( ) const

Deprecated function. Gets the turn capacity. Use getCapacity() instead.

◆ clearTurningEntities()

void GKTurning::clearTurningEntities ( )

Clears all the turn entities

◆ curve()

void GKTurning::curve ( )

Gives the turn a default curve

◆ getAdditionalVolume()

double GKTurning::getAdditionalVolume ( ) const

Returns the Additional Volume

◆ getCapacity()

double GKTurning::getCapacity ( ) const

Gets the turn capacity

◆ getDestination()

GKSection * GKTurning::getDestination ( ) const

Returns the destination of the turn.

◆ getDestinationFromLane()

uint GKTurning::getDestinationFromLane ( ) const

Gets the left most lane number (from 0 to N-1) used in the destination section by this turn.

◆ getDestinationToLane()

uint GKTurning::getDestinationToLane ( ) const

Gets the right most lane number (from 0 to N-1) used in the destination section by this turn.

◆ getDynamicFunction()

GKFunctionCost * GKTurning::getDynamicFunction ( ) const

Get the Dynamic Cost Function for the turn.

◆ getInitialFunction()

GKFunctionCost * GKTurning::getInitialFunction ( ) const

Get the Initial Cost Function for the turn.

◆ getJunctionDelayFunction()

const GKFunctionCost * GKTurning::getJunctionDelayFunction ( ) const

Get the Junction Delay Function for the turn.

◆ getKInitialsFunction()

GKFunctionCost * GKTurning::getKInitialsFunction ( ) const

Get the K-Initials Cost Function for the turn.

◆ getNode()

GKNode * GKTurning::getNode ( ) const

Gets the node of this turn.

◆ getOrigin()

GKSection * GKTurning::getOrigin ( ) const

Returns the origin of the turn.

◆ getOriginFromLane()

uint GKTurning::getOriginFromLane ( ) const

Gets the left most lane number (from 0 to N-1) used in the origin section by this turn.

◆ getOriginToLane()

uint GKTurning::getOriginToLane ( ) const

Gets the right most lane number (from 0 to N-1) used in the origin section by this turn.

◆ getPolygon()

GKPoints GKTurning::getPolygon ( ) const

Returns a detailed polygon (incluing and end arrow) for this turn

◆ getReactionTimeFactor()

double GKTurning::getReactionTimeFactor ( ) const

Gets the reaction time factor for the turn (Meso).

◆ getSpeed()

double GKTurning::getSpeed ( ) const

Gets the turn speed in km/h

◆ getStopLineByPoint()

double GKTurning::getStopLineByPoint ( const GKPoint p) const

Returns the stop line under a point or -1.0f if no stop line exists.s

◆ getStopLines()

const QVector< GKStopLine > & GKTurning::getStopLines ( ) const

Gets the stop line distance relative to the start of the turn (in m)

◆ getTurningEntities()

const GKTurningEntities & GKTurning::getTurningEntities ( ) const

Gets all the turning entities related with this turn.

◆ getTurnPenaltyFunction()

const GKFunctionCost * GKTurning::getTurnPenaltyFunction ( ) const

Get the Turn Penalty Function for the turn.

◆ getUserDefinedCost()

double GKTurning::getUserDefinedCost ( ) const

Returns the user-defined cost 1

◆ getUserDefinedCost2()

double GKTurning::getUserDefinedCost2 ( ) const

Returns the user-defined cost 2

◆ getUserDefinedCost3()

double GKTurning::getUserDefinedCost3 ( ) const

Returns the user-defined cost 3

◆ getWarningIndicator()

GKWarningIndicator GKTurning::getWarningIndicator ( ) const

Gets the warning indicator

◆ isAutoSpeed()

bool GKTurning::isAutoSpeed ( ) const

The speed of this turn is calculated automatically?

◆ isInternalRoundaboutTurning()

bool GKTurning::isInternalRoundaboutTurning ( ) const

True if the turn is part of a roundabout node and it's not an entrance/exit to/from the roundabout

◆ isUsingRoadTypeDistanceZones()

bool GKTurning::isUsingRoadTypeDistanceZones ( ) const

returns whether the turn is using its own look-ahead distance values or it is using the origin section look-ahead distance values

◆ removeAllStopLines()

void GKTurning::removeAllStopLines ( )

Removes all the stop lines

◆ removeStopLine()

void GKTurning::removeStopLine ( GKStopLine  stopLine)

Removes the stop line distance relative to the start of the turn (in m)

◆ setAttractiveness()

void GKTurning::setAttractiveness ( double  value)

Sets the turn attractiveness

◆ setAutomaticCapacity()

End void GKTurning::setAutomaticCapacity ( bool  value)

If true (the default) the capacity is calculated automatically. Otherwise, is defined by the user.

◆ setAutoSpeed()

void GKTurning::setAutoSpeed ( bool  )

The speed of this turn is calculated automatically?

◆ setCapacity()

void GKTurning::setCapacity ( double  value)

Sets the turn capacity

◆ setConnection()

virtual void GKTurning::setConnection ( GKSection ,
GKSection  
)
virtual

Sets the origin and destination objects that this turn links. This function calculates an initial shape for the connection.

◆ setDestination()

virtual void GKTurning::setDestination ( GKSection )
virtual

Changes the destination of this turn. This function DON'T change the connection shape

◆ setDestinationLanes()

void GKTurning::setDestinationLanes ( uint  ,
uint   
)

Sets the lanes (from 0 to N-1) used in the destination section by this turn.

◆ setDynamicFunction()

void GKTurning::setDynamicFunction ( GKFunctionCost fc)

Set the Dynamic Cost Function for the turn.

◆ setInitialFunction()

void GKTurning::setInitialFunction ( GKFunctionCost fc)

Set the Initial Cost Function for the turn.

◆ setInternalRoundaboutTurning()

void GKTurning::setInternalRoundaboutTurning ( bool  value)

True if the turn is part of a roundabout node and it's not an entrance/exit to/from the roundabout

◆ setJunctionDelayFunction()

void GKTurning::setJunctionDelayFunction ( const GKFunctionCost fc)

Sets the Junction Delay Function for the turn.

◆ setKInitialsFunction()

void GKTurning::setKInitialsFunction ( GKFunctionCost fc)

Set the K-Initials Cost Function for the turn.

◆ setNode()

void GKTurning::setNode ( GKNode )

Sets, when creating the turn, the node. It cannot be changed later on.

◆ setOrigin()

virtual void GKTurning::setOrigin ( GKSection )
virtual

Changes the origin of this turn. This function DON'T change the connection shape

◆ setOriginLanes()

void GKTurning::setOriginLanes ( uint  ,
uint   
)

Sets the lanes (from 0 to N-1) used in the origin section by this turn.

◆ setReactionTimeFactor()

void GKTurning::setReactionTimeFactor ( double  reactionTimeFactor)

Set the reaction time factor for the turn (Meso).

◆ setSpeed()

void GKTurning::setSpeed ( double  )

Sets the turn speed in km/h

◆ setStopLineLength()

void GKTurning::setStopLineLength ( int  p,
double  length 
)

Set the stop line distance of the pth stop line.

◆ setStopLinePosition()

void GKTurning::setStopLinePosition ( int  p,
double  position 
)

Set the stop line position of the pth stop line.

◆ setTurningEntitiesProps()

void GKTurning::setTurningEntitiesProps ( unsigned short  _of,
unsigned short  _ot,
unsigned short  _df,
unsigned short  _dt 
)

Sets the lanes info of the turning entities

◆ setTurnPenaltyFunction()

void GKTurning::setTurnPenaltyFunction ( const GKFunctionCost fc)

Sets the Turn Penalty Function for the turn.

◆ setUseCapacityAsAttractiveness()

void GKTurning::setUseCapacityAsAttractiveness ( bool  value)

If true (the default) the capacity is used as attractiveness. Otherwise, uses the attractiveness defined by the user.

◆ setUseRoadTypeDistanceZones()

void GKTurning::setUseRoadTypeDistanceZones ( bool  value)

if true, the turn will take look-ahead distance values from origin section, otherwise, it will use its own values

◆ setWarningIndicator()

void GKTurning::setWarningIndicator ( GKWarningIndicator  )

Sets the warning indicator

◆ translatedByNode()

void GKTurning::translatedByNode ( const GKPoint )

Translates a turn (due to a node translation). Don't call this function.

◆ updatePath()

void GKTurning::updatePath ( bool  )

Recalculates the turn path after a change in the origin and/or destination section geometry.

If the speed is automatic it will evaluate it unless the updateSpeedIfAuto is false (and will be false true the updatePath comes from a restore operation).

◆ useCapacityAsAttractiveness()

bool GKTurning::useCapacityAsAttractiveness ( ) const

If true (the default) the capacity is used as attractiveness. Otherwise, uses the attractiveness defined by the user.

Member Data Documentation

◆ autoSpeedAtt

uint GKTurning::autoSpeedAtt
static

Whether the turn speed is automatically calculated or not

◆ destinationSectionAtt

uint GKTurning::destinationSectionAtt
static

Read only destination section attribute

◆ dynamicFunctionAtt

uint GKTurning::dynamicFunctionAtt
static

Dynamic Cost Function as a GKFunctionCost object. Use GKObject::setDataValueObject and GKObject::getDataValueObject to set and get this value.

◆ initialFunctionAtt

uint GKTurning::initialFunctionAtt
static

Initial Cost Function as a GKFunctionCost object. Use GKObject::setDataValueObject and GKObject::getDataValueObject to set and get this value.

◆ kInitialsFunctionAtt

uint GKTurning::kInitialsFunctionAtt
static

K-Initials Cost Function as a GKFunctionCost object. Use GKObject::setDataValueObject and GKObject::getDataValueObject to set and get this value.

◆ nodeAtt

uint GKTurning::nodeAtt
static

Node of this turn. Use GKObject::getDataValueObject to get this value. Reaction time factor (Meso) attribute.

◆ originSectionAtt

uint GKTurning::originSectionAtt
static

Read only origin section attribute

◆ reactionTimeFactorAtt

uint GKTurning::reactionTimeFactorAtt
static

◆ sipRes

MethodCode GKTurning::sipRes = sipCpp ->getCapacity()

◆ speedAtt

uint GKTurning::speedAtt
static

Turn speed in km/h as a double

◆ stopLineDistanceAtt

uint GKTurning::stopLineDistanceAtt
static

The first stop line (can have more thn one) distance relative to the start of the turn (in m)

◆ warningAtt

uint GKTurning::warningAtt
static

Warning indicator as the GKWarningIndicator enum

◆ yellowBoxBehaviourAtt

uint GKTurning::yellowBoxBehaviourAtt
static

© Aimsun SLU
Aimsun ®