Aimsun Next Scripting  22
Public Types | Public Member Functions | Public Attributes | List of all members
GKControlMetering Class Reference
Inheritance diagram for GKControlMetering:
GKControlDelayMetering GKControlFlowMetering GKControlGreenMetering GKControlFlowAlineaMetering GKControlGreenMeteringByLane

Public Types

enum  GKControlMeteringType { eUnspecified = 0 , eUncontrolled = 1 , eFixedControl = 2 , eExternal = 3 }
 

Public Member Functions

 if (base)
 
Py_END_ALLOW_THREADS End GKControlMetering ()
 
void setMetering (GKMetering *)
 
GKMeteringgetMetering () const
 
qint32 getMeteringId () const
 
void setControlMeteringType (const GKControlMeteringType)
 
const GKControlMeteringType getControlMeteringType () const
 

Public Attributes

ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKControlMeteringbase = (GKControlMetering*)sipCpp
 
 sipType = 0
 

Detailed Description

Base class for all the control metering types.

Member Enumeration Documentation

◆ GKControlMeteringType

Control type applied to this metering. Itr can be:

  • eUnspecified: no data has been edited so the node will be uncontrolled.
  • eUncontrolled: the node has been marked as uncontrolled.
  • eFixedControl: fixed time control plan.
  • eExternal: control plan controlled by an external source (AAPI, VS-PLUS, UTOPIA, SCATS, SICE, Yunex UTC (using SCOOT), ETRA, ...)
Enumerator
eUnspecified 
eUncontrolled 
eFixedControl 
eExternal 

Constructor & Destructor Documentation

◆ GKControlMetering()

Py_END_ALLOW_THREADS End GKControlMetering::GKControlMetering ( )

Member Function Documentation

◆ getControlMeteringType()

const GKControlMeteringType GKControlMetering::getControlMeteringType ( ) const

Gets the control type.

◆ getMetering()

GKMetering * GKControlMetering::getMetering ( ) const

Gets the metering to be used.

◆ getMeteringId()

qint32 GKControlMetering::getMeteringId ( ) const

Gets the metering id used in this metering control.

◆ if()

GKControlMetering::if ( base  )
inline

References base, GKSystem::getSystem(), and sipType.

◆ setControlMeteringType()

void GKControlMetering::setControlMeteringType ( const  GKControlMeteringType)

Sets the control type.

◆ setMetering()

void GKControlMetering::setMetering ( GKMetering )

Assign the metering to be used.

Member Data Documentation

◆ base

ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKControlMetering* GKControlMetering::base = (GKControlMetering*)sipCpp

Referenced by if().

◆ sipType

GKControlMetering::sipType = 0

Referenced by if().

© Aimsun SLU
Aimsun ®