Inheritance diagram for GKController:

Public Types
enum	GKControllerType { eSCATS =0 , eUTOPIA =1 , eVSPLUS =2 , eSICE =3 , eSCOOT =4 , eETRA =5 , eTELVENT =6 , eTELENT =7 , eZGZPRIO =8 , eIndra =10 , eDummy =11 , eSCATSRMS =12 , eLISAPLUS =13 , eSitrafficOffice =14 }

enum	GKControllerState { eNormal , eConnected , eDisconnected }

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::IdentifierFormFlag >	IdentifierForm

Public Member Functions
	GKController ()

GKControllerType	getControllerType () const

void	setControllerType (const GKControllerType atype)

const GKControllerPars *	getParameters () const

void	setParameters (const GKControllerPars *pars) const

void	setState (GKControllerState astate)

GKControllerState	getState () const

GKControllerSignalGroup *	createSignalGroup () const

void	clearSignalGroups ()

void	addSignalGroup (GKControllerSignalGroup *sg)

void	removeSignalGroup (GKControllerSignalGroup *sg)

const QVector< GKControllerSignalGroup * > &	getSignalGroups () const

GKControllerDetector *	createDetector () const

void	clearDetectors ()

void	addDetector (GKControllerDetector *sg)

void	removeDetector (GKControllerDetector *sg)

const QVector< GKControllerDetector * > &	getDetectors () const

QVector< GKMetering * >	getMeterings () const

GKControllerPedestrianWalk *	createPedestrianWalk () const

void	clearPedestrianWalks ()

void	addPedestrianWalk (GKControllerPedestrianWalk *sg)

void	removePedestrianWalk (GKControllerPedestrianWalk *sg)

const QVector< GKControllerPedestrianWalk * > &	getPedestrianWalks () const

virtual GKObjectConnectionDelCmd *	getDelConnectionCmd (GKObject *target)

void	nonCommandObjectRemoved (GKObject *target)

bool	getShowConnections () const

void	setShowConnections (bool value)

bool	hasExternalControl (const GKMasterControlPlan *plan) const

Public Member Functions inherited from GKDPoint
	GKDPoint ()

const GKPoint &	getPosition () const

virtual void	setPosition (const GKPoint &p)

virtual void	translate (const GKPoint &delta)

virtual void	rotate (const GKPoint &center, double angle)

virtual GKCoord	getAltitude () const

virtual void	setAltitude (GKCoord value)

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

GKLayer *	getLayer () 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

GKGeoObject *	getBottomObject () 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 GKObject *	clone (bool addItToModel=true) const

virtual GKObject *	cloneAsTemporary (bool addItToModel=true) const

GKFolder *	getCreateRootFolder ()

GKFolder *	getRootFolder () const

void	setRootFolder (GKFolder *afolder)

GKFolder *	findFolder (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 GKTimeSerie *	getDataValueTS (const GKColumn *attr) const

GKTimeSerie *	getDataValueTSByID (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 GKObject *	getDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const

GKObject *	getDataValueObjectByID (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 GKObject *	getMaster () const

GKType *	getType () const

virtual void	setType (GKType *atype)

bool	isA (const GKType *atype) const

bool	isA (const QString &typeName) const

virtual void	setModel (GKModel *amodel)

GKModel *	getModel () 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 GKObject *	getMaster () const =0

virtual const QString &	getName () const =0

virtual const QString &	getExternalId () const =0

virtual const QString &	getDescription () const =0

virtual GKModel *	getModel () 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 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 GKObject *	getDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const =0

virtual GKObject *	getDataValueObjectByID (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	portAtt

static uint	ipAddressAtt

static uint	controllerTypeAtt

static uint	enabledAtt

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 Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObject *	base = (GKBaseObject*)sipCpp

	sipType = 0

Member Enumeration Documentation

◆ GKControllerState

enum GKController::GKControllerState

Controller state:

eNormal: no simulation is running.
eConnected: a simulation is running and the controller is connected.
eDisconnected: a simulation is running and the controller is not connected as the communication has failed.

Enumerator
eNormal
eConnected
eDisconnected

◆ GKControllerType

enum GKController::GKControllerType

The different types of controllers that Aimsun can emulate are: SCATS, SCATSRMS, UTOPIA, VSPLUS, SICE, Yunex UTC (using SCOOT), ETRA, Indra, TELVENT, TELENT and LISA. Aimsun Next will be able to communicate with any of these traffic control systems or traffic management software

Enumerator
eSCATS
eUTOPIA
eVSPLUS
eSICE
eSCOOT
eETRA
eTELVENT
eTELENT
eZGZPRIO
eIndra
eDummy
eSCATSRMS
eLISAPLUS
eSitrafficOffice

Constructor & Destructor Documentation

◆ GKController()

GKController::GKController ( )

Member Function Documentation

◆ addDetector()

void GKController::addDetector ( GKControllerDetector * sg )

Adds a detector to this controller. The object is adopted.

◆ addPedestrianWalk()

void GKController::addPedestrianWalk ( GKControllerPedestrianWalk * sg )

Adds a pedestrian walk to this controller. The object is adopted.

◆ addSignalGroup()

void GKController::addSignalGroup ( GKControllerSignalGroup * sg )

Adds a signal group to this controller. The object is adopted.

◆ clearDetectors()

void GKController::clearDetectors ( )

Removes all detectors from this controller. The objects are deleted.

◆ clearPedestrianWalks()

void GKController::clearPedestrianWalks ( )

Removes all pedestrian walks from this controller. The objects are deleted.

◆ clearSignalGroups()

void GKController::clearSignalGroups ( )

Removes all signal groups from this controller. The objects are deleted.

◆ createDetector()

GKControllerDetector * GKController::createDetector ( ) const

Creates a detector to be add later on in this controller using GKController::addDetector

◆ createPedestrianWalk()

GKControllerPedestrianWalk * GKController::createPedestrianWalk ( ) const

Creates a pedestrian walk to be add later on in this controller using GKController::addPedestrianWalk

◆ createSignalGroup()

GKControllerSignalGroup * GKController::createSignalGroup ( ) const

Creates a signal group to be add later on in this controller using GKController::addSignalGroup

◆ getControllerType()

GKControllerType GKController::getControllerType ( ) const

Returns the type of this controller among the different types of controllers that Aimsun can emulate. Aimsun Next will be able to communicate with any of these traffic control systems or traffic management software

◆ getDelConnectionCmd()

virtual GKObjectConnectionDelCmd * GKController::getDelConnectionCmd ( GKObject * target )

virtual

This object has connections to "target" and "target" will be removed. Create and return a delete command to handle undo and redo of the affected connections. If the object is deleted outside a command (no UNDO) then the model will call GKObject::nonCommandObjectRemoved instead.

If this method returns a None it means that the delete is not possible and the command will not be done. If an object is connected to another but decides that no information is needed in the delete command then it has to return an empty GKObjectConnectionDelCmd instead of a None.

◆ getDetectors()

const QVector< GKControllerDetector * > & GKController::getDetectors ( ) const

List all the detectors in this controller.

◆ getMeterings()

QVector< GKMetering * > GKController::getMeterings ( ) const

List all the meterings in this controller.

◆ getParameters()

const GKControllerPars * GKController::getParameters ( ) const

Gets the controller parameters based on its type. For controllers eSCATS, eSCATSRMS, eSICE, eIndra and eDummy it will return a GKControllerPars object. For controllers eUTOPIA it will return a GKControllerParsUTOPIA object. For controllers eVSPLUS and eZGZPRIO it will return a GKControllerParsVSPLUS object. For controllers eETRA it will return a GKControllerParsETRA object. For controllers eTELVENT it will return a GKControllerParsTelvent object. For controllers eTELENT it will return a GKControllerParsTelent object. For controllers eSCOOT it will return a GKControllerParsTelent object. For controllers eLISAPLUS it will return a GKControllerParsLISAPlus object.

◆ getPedestrianWalks()

const QVector< GKControllerPedestrianWalk * > & GKController::getPedestrianWalks ( ) const

List all the pedestrian walk in this controller.

◆ getShowConnections()

bool GKController::getShowConnections ( ) const

When drawing, show the connections?

◆ getSignalGroups()

const QVector< GKControllerSignalGroup * > & GKController::getSignalGroups ( ) const

List all the signal groups in this controller.

◆ getState()

GKControllerState GKController::getState ( ) const

The controller state.

See also: GKController::GKControllerState

◆ hasExternalControl()

bool GKController::hasExternalControl ( const GKMasterControlPlan * plan ) const

Returns true if the controller has an External Control defined in any item of the given master control plan.

◆ nonCommandObjectRemoved()

void GKController::nonCommandObjectRemoved ( GKObject * )

virtual

This object has connections to "target" and "target" will be removed. No command is required as the object is deleted outside a command (if is deleted in a command the model will call GKObject::getDelConnectionCmd instead).

◆ removeDetector()

void GKController::removeDetector ( GKControllerDetector * sg )

Removes a detector from this controller. The object is deleted.

◆ removePedestrianWalk()

void GKController::removePedestrianWalk ( GKControllerPedestrianWalk * sg )

Removes a pedestrian walk from this controller. The object is deleted.

◆ removeSignalGroup()

void GKController::removeSignalGroup ( GKControllerSignalGroup * sg )

Removes a signal group from this controller. The object is deleted.

◆ setControllerType()

void GKController::setControllerType ( const GKControllerType atype )

Sets the type of this controller among the different types of controllers that Aimsun can emulate. Aimsun Next will be able to communicate with any of these traffic control systems or traffic management software

◆ setParameters()

void GKController::setParameters ( const GKControllerPars * pars ) const

Sets the controller parameters based on its type. Be sure that pars parameter has the correct type as set by GKController::setControllerType, that are: For controllers eSCATS, eSCATSRMS, eSICE, eIndra and eDummy a GKControllerPars object. For controllers eUTOPIA a GKControllerParsUTOPIA object. For controllers eVSPLUS and eZGZPRIO a GKControllerParsVSPLUS object. For controllers eETRA a GKControllerParsETRA object. For controllers eTELVENT a GKControllerParsTelvent object. For controllers eTELENT a GKControllerParsTelent object. For controllers eSCOOT a GKControllerParsTelent object. For controllers eLISAPLUS a GKControllerParsLISAPlus object.

The pars object is copied.

◆ setShowConnections()

void GKController::setShowConnections ( bool value )

When drawing, show the connections?

◆ setState()

void GKController::setState ( GKControllerState astate )

The controller state.

See also: GKController::GKControllerState

Member Data Documentation

◆ controllerTypeAtt

uint GKController::controllerTypeAtt

static

Controller Type attribute.

◆ enabledAtt

uint GKController::enabledAtt

static

Enabled Controller.

◆ ipAddressAtt

uint GKController::ipAddressAtt

static

IP AddressAtt attribute.

◆ portAtt

uint GKController::portAtt

static

Basic Attributes:

The TCP/IP Port.

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ GKControllerState

◆ GKControllerType

Constructor & Destructor Documentation

◆ GKController()

Member Function Documentation

◆ addDetector()

◆ addPedestrianWalk()

◆ addSignalGroup()

◆ clearDetectors()

◆ clearPedestrianWalks()

◆ clearSignalGroups()

◆ createDetector()

◆ createPedestrianWalk()

◆ createSignalGroup()

◆ getControllerType()

◆ getDelConnectionCmd()

◆ getDetectors()

◆ getMeterings()

◆ getParameters()

◆ getPedestrianWalks()

◆ getShowConnections()

◆ getSignalGroups()

◆ getState()

◆ hasExternalControl()

◆ nonCommandObjectRemoved()

◆ removeDetector()

◆ removePedestrianWalk()

◆ removeSignalGroup()

◆ setControllerType()

◆ setParameters()

◆ setShowConnections()

◆ setState()

Member Data Documentation

◆ controllerTypeAtt

◆ enabledAtt

◆ ipAddressAtt

◆ portAtt