Aimsun Next Scripting  22
Enumerations | Functions | Variables
GK Namespace Reference

Enumerations

enum  AggregationType {
  eAggregationUndefined , eAggregationDefault , eAggregationMean , eAggregationSum ,
  eAggregationCustom , eAggregationMax , eAggregationMin
}
 
enum  NullMeaning {
  eNullMeansUndefined , eNullMeansAll , eNullMeansAny , eNullMeansNew ,
  eNullMeansNone , eNullMeansTotal , eNullMeansSameAsReference , eNullMeansDefault
}
 
enum  ODType {
  eODUndefined , eODDestination , eODOrigin , eODBoth ,
  eODNone
}
 
enum  ConnectionType {
  eConnectionUndefined , eFrom , eTo , eBidirectional ,
  eConnectionNone
}
 
enum  RoadSide { eRoadUndefined = -1 , eRoadRight = 0 , eRoadLeft = 1 }
 
enum  LatitudeLongitudeType { eLatitudeUndefined = -1 , eLatitudeAsDecimal = 0 , eLatitudeAsDegree = 1 }
 
enum  SizeUnits {
  ePixels , eCentimeters , eMeters , eKilometers ,
  eInches , eFeet , eMiles , eDegrees
}
 
enum  UnitSystem { eUnitSystemUndefined = 0 , eMetric = 1 , eEnglish = 2 }
 
enum  DetailLevel {
  eMicro , eMeso , eMacro , eTravelDemand ,
  eDynamicMacro , eMesoMicroHybrid , eMacroMesoHybrid
}
 
enum  ObjectDeletionBehaviour { eDeleteObjects , eDoNotDeleteObjects }
 
enum  Conversion {
  eConversionUndefined = 0 , eDistance = 1 , eArea = 2 , eSpeed = 3 ,
  eAcceleration = 4 , eReliability = 5 , eWeight = 6 , eSpeedMS = 7 ,
  eDensity = 8 , eStopsDensity = 9 , eDistanceKM = 10 , eTravelTimeDistance = 11 ,
  eFuelConsumption = 12 , eInstantFuelConsumption = 13 , eDistanceFuelConsumption = 14 , eEmission = 15 ,
  eInstantEmission = 16 , eDistanceEmission = 17 , eStops = 18 , eTemperature = 19 ,
  ePerKM = 20 , eSeconds , eMinutes , eHours ,
  eVehicle , eVehiclePerHour , ePedestrian , ePedestrianPerHour ,
  ePCU , ePCUPerHour , ePercent , eLevelOfService ,
  eWeightHorsePower , eWeightFrontArea , eEmissionPerHour , eBatteryConsumption ,
  eInstantBatteryConsumption , eDistanceBatteryConsumption
}
 

Functions

GKContent BuildOriginatorContent (const GKObject *o)
 
GKContent BuildLastGeneratedContent ()
 
GKContent BuildMainContent (const GKContent::Id &id, const QString &name="")
 
TypeHeaderCode End int GetMax (const QList< int > &values)
 
int GetMin (const QList< int > &values)
 
double GetMax (const QList< double > &values)
 
double GetMin (const QList< double > &values)
 
int GetMax (const QVector< int > &values)
 
int GetMin (const QVector< int > &values)
 
double GetMax (const QVector< double > &values)
 
double GetMin (const QVector< double > &values)
 
double GetMean (const QVector< double > &values)
 
double GetWeightedMean (const QVector< double > &values, const QVector< double > &weights)
 
double GetSum (const QVector< double > &values)
 
double GetStdDeviation (const QVector< double > &values)
 
double GetWeightedStdDeviation (const QVector< double > &values, const QVector< double > &weights)
 
QVector< GKObject * > GetObjectsOfType (GKType *type, bool includeSubTypes=true, bool sort=true)
 
GKContents BuildContents (const QString &mainId, const GKObject *originator, const GKBaseObject *userClass)
 
GKContents BuildContents (const QString &mainId, const QString &mainDescription, const GKObject *originator, const GKBaseObject *userClass)
 
GKContents BuildContents (const QString &mainId, const GKObject *originator)
 
GKContents BuildContentsUC (const QString &mainId, const GKObject *userClass)
 
GKContent BuildUserClassContent (const GKBaseObject *userClass, GK::NullMeaning meaning=GK::eNullMeansAll)
 
GKContent BuildLaneContent (int laneIndex)
 
GKContent BuildLaneContentAll ()
 
GKContent BuildSignalGroupContent (int sgIndex)
 
GKContent BuildSignalGroupContentAll ()
 
GKContent BuildOriginContent (const GKObject *origin)
 
GKContent BuildDestinationContent (const GKObject *destination)
 
GKContent BuildPTLineTypeContent (const GKPublicLine *ptLine, GK::NullMeaning meaning=GK::eNullMeansAll)
 
GKContent BuildPTLineTypeContentAll ()
 
GKContent BuildPollutantContent (const QString &pollutant)
 
GKContent BuildPollutantContentAll ()
 
GKContent BuildODTypeContent (GK::ODType odType)
 
GKContent BuildAggregationTypeContent (GK::AggregationType aggType)
 
GKContent BuildLinkContent ()
 
GKContent BuildSIContent ()
 

Variables

TypeHeaderCode End const GKContent::Type eContentMain
 
const GKContent::Type eContentOriginator
 
const GKContent::Type eContentUserClass
 
const GKContent::Type eContentLane
 
const GKContent::Type eContentSectionPTSegment
 
const GKContent::Type eContentSignalGroup
 
const GKContent::Type eAllContentOrigin
 
const GKContent::Type eContentOrigin
 
const GKContent::Type eAllContentDestination
 
const GKContent::Type eContentDestination
 
const GKContent::Type eContentODType
 
const GKContent::Type eContentAggregationType
 
const GKContent::Type eContentPTLine
 
const GKContent::Type eContentPTZone
 
const GKContent::Type eContentPollutant
 
const GKContent::Type eContentLink
 
const GKContent::Type eContentSI
 
const GKContent::Type eContentGKType
 
const GKContent::Type eContentControlJunction
 
const GKContent::Type eContentSynthetiser
 
const GKContent::Type eContentSynthetisation
 
const GKContent::Type eContentPTRun
 
const GKContent::Id eAllLanesId
 
const GKContent::Id eAllSGId
 
const GKContent::Id eAllUserClass
 
const GKContent::Id eAllPTLine
 
const GKContent::Id eAllPTZone
 
const GKContent::Id eAllPollutant
 
const GKContent::Id eAllPTRun
 

Enumeration Type Documentation

◆ AggregationType

enum GK::AggregationType

Different way to aggregate values

Enumerator
eAggregationUndefined 
eAggregationDefault 
eAggregationMean 
eAggregationSum 
eAggregationCustom 
eAggregationMax 
eAggregationMin 

◆ ConnectionType

enum GK::ConnectionType

Connection type between two entities A and B:

  • eTo: A to B
  • eFrom: A from B
  • eBidirectional: A from B and A to B
  • eConnectionNone: A and B are not connected
  • eConnectionUndefined: unknown
Enumerator
eConnectionUndefined 
eFrom 
eTo 
eBidirectional 
eConnectionNone 

◆ Conversion

enum GK::Conversion

Physical dimensions of values in various units ( 'distance by time' can either correspond to eSpeed (km/h in eMetric) or to eSpeedMS (m/s in eMetric) ). Each Conversion corresponds to a conversion factor between two different UnitSystem.

Enumerator
eConversionUndefined 
eDistance 
eArea 
eSpeed 
eAcceleration 
eReliability 
eWeight 
eSpeedMS 
eDensity 
eStopsDensity 
eDistanceKM 
eTravelTimeDistance 
eFuelConsumption 
eInstantFuelConsumption 
eDistanceFuelConsumption 
eEmission 
eInstantEmission 
eDistanceEmission 
eStops 
eTemperature 
ePerKM 
eSeconds 
eMinutes 
eHours 
eVehicle 
eVehiclePerHour 
ePedestrian 
ePedestrianPerHour 
ePCU 
ePCUPerHour 
ePercent 
eLevelOfService 
eWeightHorsePower 
eWeightFrontArea 
eEmissionPerHour 
eBatteryConsumption 
eInstantBatteryConsumption 
eDistanceBatteryConsumption 

◆ DetailLevel

enum GK::DetailLevel

Simulation detail levels.

Enumerator
eMicro 
eMeso 
eMacro 
eTravelDemand 
eDynamicMacro 
eMesoMicroHybrid 
eMacroMesoHybrid 

◆ LatitudeLongitudeType

enum GK::LatitudeLongitudeType

Latiture & Longitude type.

Enumerator
eLatitudeUndefined 
eLatitudeAsDecimal 
eLatitudeAsDegree 

◆ NullMeaning

enum GK::NullMeaning

Description of possible meanings of a NULL value.

Enumerator
eNullMeansUndefined 
eNullMeansAll 
eNullMeansAny 
eNullMeansNew 
eNullMeansNone 
eNullMeansTotal 
eNullMeansSameAsReference 
eNullMeansDefault 

◆ ObjectDeletionBehaviour

enum GK::ObjectDeletionBehaviour

Object deletion behavior.

Enumerator
eDeleteObjects 
eDoNotDeleteObjects 

◆ ODType

enum GK::ODType

Origin/Destination roles.

Enumerator
eODUndefined 
eODDestination 
eODOrigin 
eODBoth 
eODNone 

◆ RoadSide

enum GK::RoadSide

Road sides.

Enumerator
eRoadUndefined 
eRoadRight 
eRoadLeft 

◆ SizeUnits

enum GK::SizeUnits

Units to express a size.

Enumerator
ePixels 
eCentimeters 
eMeters 
eKilometers 
eInches 
eFeet 
eMiles 
eDegrees 

◆ UnitSystem

enum GK::UnitSystem

Unit systems.

Enumerator
eUnitSystemUndefined 
eMetric 
eEnglish 

Function Documentation

◆ BuildAggregationTypeContent()

GKContent GK::BuildAggregationTypeContent ( GK::AggregationType  aggType)

Builds a GK.eContentAggregationType content with the specified aggType.

◆ BuildContents() [1/3]

GKContents GK::BuildContents ( const QString &  mainId,
const GKObject *  originator 
)

Builds a GKContents that contains an agglomeration of:

◆ BuildContents() [2/3]

GKContents GK::BuildContents ( const QString &  mainId,
const GKObject *  originator,
const GKBaseObject *  userClass 
)

Builds a GKContents that contains an agglomeration of:

◆ BuildContents() [3/3]

GKContents GK::BuildContents ( const QString &  mainId,
const QString &  mainDescription,
const GKObject *  originator,
const GKBaseObject *  userClass 
)

Same as BuildContents(const QString& mainId, const GKObject* originator, const GKBaseObject * userClass), but allowing you to specify the mainDescription (a.k.a the label of the GK.eContentMain shown to the user).

◆ BuildContentsUC()

GKContents GK::BuildContentsUC ( const QString &  mainId,
const GKObject *  userClass 
)

Builds a GKContents that contains an agglomeration of:

◆ BuildDestinationContent()

GKContent GK::BuildDestinationContent ( const GKObject *  destination)

Builds a GK.eContentDestination content with the id of the specified origin.

◆ BuildLaneContent()

GKContent GK::BuildLaneContent ( int  laneIndex)

Builds a GK.eContentLane content with the specified laneIndex.

◆ BuildLaneContentAll()

GKContent GK::BuildLaneContentAll ( )

Builds a GK.eContentLane content for an 'All Lanes' GKColumn.

◆ BuildLastGeneratedContent()

GKContent GK::BuildLastGeneratedContent ( )

Builds a GKContent of type eContentOriginator describing the Last Generated originator.

◆ BuildLinkContent()

GKContent GK::BuildLinkContent ( )

Builds a GK.eContentLink content, that indicates that the GKColumn relates to the link of the GKTurning.

◆ BuildMainContent()

GKContent GK::BuildMainContent ( const GKContent::Id &  id,
const QString &  name = "" 
)

Builds a GKContent of type eContentMain using the specified id and name.

◆ BuildODTypeContent()

GKContent GK::BuildODTypeContent ( GK::ODType  odType)

Builds a GK.eContentODType content with the specified odType.

◆ BuildOriginatorContent()

GKContent GK::BuildOriginatorContent ( const GKObject *  o)

Builds a GKContent of type eContentOriginator describing the specified GKObject.

◆ BuildOriginContent()

GKContent GK::BuildOriginContent ( const GKObject *  origin)

Builds a GK.eContentOrigin content with the id of the specified origin.

Note
The 'origin' is not the originator. The origin is more likely to refer to, f.ex., the origin centroid of a trip.

◆ BuildPollutantContent()

GKContent GK::BuildPollutantContent ( const QString &  pollutant)

Builds a GK.eContentPollutant content with the specfied id.

◆ BuildPollutantContentAll()

GKContent GK::BuildPollutantContentAll ( )

Builds a GK.eContentPollutant content for an 'All pollutants' GKColumn.

◆ BuildPTLineTypeContent()

GKContent GK::BuildPTLineTypeContent ( const GKPublicLine *  ptLine,
GK::NullMeaning  meaning = GK::eNullMeansAll 
)

Builds a GK.eContentPTLine content with the id of the specified ptLine.

◆ BuildPTLineTypeContentAll()

GKContent GK::BuildPTLineTypeContentAll ( )

Builds a GK.eContentPTLine content for an 'All Transit Lines' GKColumn.

◆ BuildSIContent()

GKContent GK::BuildSIContent ( )

Builds a GK.eContentLink content, that indicates that the GKColumn is SI.

◆ BuildSignalGroupContent()

GKContent GK::BuildSignalGroupContent ( int  sgIndex)

Builds a GK.eContentSignalGroup content with the specified sgIndex.

◆ BuildSignalGroupContentAll()

GKContent GK::BuildSignalGroupContentAll ( )

Builds a GK.eContentSignalGroup content for an 'All Signal Groups' GKColumn.

◆ BuildUserClassContent()

GKContent GK::BuildUserClassContent ( const GKBaseObject *  userClass,
GK::NullMeaning  meaning = GK::eNullMeansAll 
)

Builds a GK.eContentUserClass content with the id of the specified userClass.

Parameters
userClassdefines the userClass.
meaningdefines the corresponding label shown in the UI when the userClass in None ("None", "All", "Undefined",...).

◆ GetMax() [1/4]

double GK::GetMax ( const QList< double > &  values)

Alias for GetMax<double,QList>(values).

◆ GetMax() [2/4]

TypeHeaderCode End int GK::GetMax ( const QList< int > &  values)

Alias for GetMax<int,QList>(values).

◆ GetMax() [3/4]

double GK::GetMax ( const QVector< double > &  values)

Alias for GetMax<double,QVector>(values).

◆ GetMax() [4/4]

int GK::GetMax ( const QVector< int > &  values)

Alias for GetMax<int,QVector>(values).

◆ GetMean()

double GK::GetMean ( const QVector< double > &  values)

Returns the mean of the values.

◆ GetMin() [1/4]

double GK::GetMin ( const QList< double > &  values)

Alias for GetMin<double,QList>(values).

◆ GetMin() [2/4]

int GK::GetMin ( const QList< int > &  values)

Alias for GetMin<int,QList>(values).

◆ GetMin() [3/4]

double GK::GetMin ( const QVector< double > &  values)

Alias for GetMin<double,QVector>(values).

◆ GetMin() [4/4]

int GK::GetMin ( const QVector< int > &  values)

Alias for GetMin<int,QVector>(values).

◆ GetObjectsOfType()

QVector< GKObject * > GK::GetObjectsOfType ( GKType *  type,
bool  includeSubTypes = true,
bool  sort = true 
)

Returns all the objects of the specified type in a vector. If includeSubTypes is true, objects from all the subtypes of type will be also returned. If sort is true the objects will be sorted by ID.

◆ GetStdDeviation()

double GK::GetStdDeviation ( const QVector< double > &  values)

Returns the standard deviation of the values.

◆ GetSum()

double GK::GetSum ( const QVector< double > &  values)

Returns the sum of the values.

◆ GetWeightedMean()

double GK::GetWeightedMean ( const QVector< double > &  values,
const QVector< double > &  weights 
)

Returns the mean of the values.

◆ GetWeightedStdDeviation()

double GK::GetWeightedStdDeviation ( const QVector< double > &  values,
const QVector< double > &  weights 
)

Returns the standard deviation of the values.

Variable Documentation

◆ eAllContentDestination

const GKContent::Type GK::eAllContentDestination

◆ eAllContentOrigin

const GKContent::Type GK::eAllContentOrigin

◆ eAllLanesId

const GKContent::Id GK::eAllLanesId

◆ eAllPollutant

const GKContent::Id GK::eAllPollutant

◆ eAllPTLine

const GKContent::Id GK::eAllPTLine

◆ eAllPTRun

const GKContent::Id GK::eAllPTRun

◆ eAllPTZone

const GKContent::Id GK::eAllPTZone

◆ eAllSGId

const GKContent::Id GK::eAllSGId

◆ eAllUserClass

const GKContent::Id GK::eAllUserClass

◆ eContentAggregationType

const GKContent::Type GK::eContentAggregationType

◆ eContentControlJunction

const GKContent::Type GK::eContentControlJunction

◆ eContentDestination

const GKContent::Type GK::eContentDestination

◆ eContentGKType

const GKContent::Type GK::eContentGKType

◆ eContentLane

const GKContent::Type GK::eContentLane

◆ eContentLink

const GKContent::Type GK::eContentLink

◆ eContentMain

TypeHeaderCode End const GKContent::Type GK::eContentMain

◆ eContentODType

const GKContent::Type GK::eContentODType

◆ eContentOrigin

const GKContent::Type GK::eContentOrigin

◆ eContentOriginator

const GKContent::Type GK::eContentOriginator

◆ eContentPollutant

const GKContent::Type GK::eContentPollutant

◆ eContentPTLine

const GKContent::Type GK::eContentPTLine

◆ eContentPTRun

const GKContent::Type GK::eContentPTRun

◆ eContentPTZone

const GKContent::Type GK::eContentPTZone

◆ eContentSectionPTSegment

const GKContent::Type GK::eContentSectionPTSegment

◆ eContentSI

const GKContent::Type GK::eContentSI

◆ eContentSignalGroup

const GKContent::Type GK::eContentSignalGroup

◆ eContentSynthetisation

const GKContent::Type GK::eContentSynthetisation

◆ eContentSynthetiser

const GKContent::Type GK::eContentSynthetiser

◆ eContentUserClass

const GKContent::Type GK::eContentUserClass
Generated by   doxygen 1.9.4

© Aimsun SLU
Aimsun ®