Aimsun Next Scripting: GKSimulatedObject Class Reference
Aimsun Next Scripting  22
Public Member Functions | List of all members
GKSimulatedObject Class Reference
Inheritance diagram for GKSimulatedObject:
GKBaseObject CMacroConnection CMacroSection CMacroTrajectory CMacroTurning CMacroUserClass DTASection DTATurning DTAUserClass DTAVehicleType PTStation

Public Member Functions

 GKSimulatedObject ()
 
 GKSimulatedObject (const GKObject *master, GKModelConnection *connection=NULL)
 
virtual QString getTypeExternalName () const
 
void setMaster (GKObject *master)
 
const GKObjectgetMaster () const
 
virtual quint32 getId () const
 
virtual const QString & getName () const
 
virtual const QString & getExternalId () const
 
virtual const QString & getDescription () const
 
virtual GKModelgetModel () const
 
virtual GKTypegetType () const
 
virtual bool isA (const GKType *atype) const
 
virtual bool isA (const QString &typeName) const
 
virtual QVariant * getDataValue (const GKColumn *attr, bool *deleteit, const GKContext &context=GKContext::anyContext) const
 
virtual QVariant * getDataValueByID (uint attrId, bool *deleteit, const GKContext &context=GKContext::anyContext) const
 
virtual double getDataValueInTS (const GKColumn *attr, GKTimeSerieIndex index, double *deviation=NULL) const
 
virtual double getDataValueInTSByID (uint attrId, GKTimeSerieIndex index, double *deviation=NULL) const
 
virtual GKTimeSeriegetDataValueTS (const GKColumn *attr) const
 
virtual GKTimeSeriegetDataValueTSByID (uint attrId) const
 
virtual int getDataValueInt (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
virtual int getDataValueIntByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual double getDataValueDouble (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
virtual double getDataValueDoubleByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual QString getDataValueString (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
virtual QString getDataValueStringByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual bool getDataValueBool (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
virtual bool getDataValueBoolByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual GKObjectgetDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
virtual GKObjectgetDataValueObjectByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual QDate getDataValueDate (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
virtual QDate getDataValueDateByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
virtual QTime getDataValueTime (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
virtual 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
 
virtual GKTimeDuration getDataValueTimeDuration (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
virtual GKTimeDuration getDataValueTimeDurationByID (uint attrId, const GKContext &context=GKContext::anyContext) const
 
- 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
 

Additional Inherited Members

- Public Attributes inherited from GKBaseObject
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObjectbase = (GKBaseObject*)sipCpp
 
 sipType = 0
 
- 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

They are copies of normal objects (GKObject), called master, used by the simulation and the assignment modules.

See also
GKObjects

Constructor & Destructor Documentation

◆ GKSimulatedObject() [1/2]

GKSimulatedObject::GKSimulatedObject ( )

◆ GKSimulatedObject() [2/2]

GKSimulatedObject::GKSimulatedObject ( const GKObject master,
GKModelConnection connection = NULL 
)

Member Function Documentation

◆ getDataValue()

virtual QVariant * GKSimulatedObject::getDataValue ( const GKColumn attr,
bool *  deleteit,
const GKContext context = GKContext::anyContext 
) const
virtual

Get the value of an attribute. If no value is found None is returned. If deleteit is true the returned value must be deleted by the method that makes the call.

Implements GKBaseObject.

◆ getDataValueBool()

virtual bool GKSimulatedObject::getDataValueBool ( const GKColumn attr,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueBoolByID()

virtual bool GKSimulatedObject::getDataValueBoolByID ( uint  attrId,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueByID()

virtual QVariant * GKSimulatedObject::getDataValueByID ( uint  attrId,
bool *  deleteit,
const GKContext context = GKContext::anyContext 
) const
virtual

Get the value of an attribute. If no value is found None is returned. If deleteit is true the returned value must be deleted by the method that makes the call.

Implements GKBaseObject.

◆ getDataValueDate()

virtual QDate GKSimulatedObject::getDataValueDate ( const GKColumn attr,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueDateByID()

virtual QDate GKSimulatedObject::getDataValueDateByID ( uint  attrId,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueDateTime()

QDateTime GKSimulatedObject::getDataValueDateTime ( const GKColumn attr,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueDateTimeByID()

QDateTime GKSimulatedObject::getDataValueDateTimeByID ( uint  attrId,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueDouble()

virtual double GKSimulatedObject::getDataValueDouble ( const GKColumn attr,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueDoubleByID()

virtual double GKSimulatedObject::getDataValueDoubleByID ( uint  attrId,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueInt()

virtual int GKSimulatedObject::getDataValueInt ( const GKColumn attr,
const GKContext context = GKContext::anyContext 
) const
virtual

Helper functions (only for access). It's faster than getDataValue since it doesn't creates any intermediate QVariant for internal attributes. Note that for GKTimeSerie it returns the default value, in order to get any other value (position or condition dependant) use getDataValue to take the whole attribute

Implements GKBaseObject.

◆ getDataValueIntByID()

virtual int GKSimulatedObject::getDataValueIntByID ( uint  attrId,
const GKContext context = GKContext::anyContext 
) const
virtual

Helper functions (only for access). It's faster than getDataValue since it doesn't creates any intermediate QVariant for internal attributes. Note that for GKTimeSerie it returns the default value, in order to get any other value (position or condition dependant) use getDataValue to take the whole attribute

Implements GKBaseObject.

◆ getDataValueInTS()

virtual double GKSimulatedObject::getDataValueInTS ( const GKColumn attr,
GKTimeSerieIndex  index,
double *  deviation = NULL 
) const
virtual

Get a value for a TimeSerie or 0.0 if no value is found (no value for the interval) and, optionally, its deviation

Implements GKBaseObject.

◆ getDataValueInTSByID()

virtual double GKSimulatedObject::getDataValueInTSByID ( uint  attrId,
GKTimeSerieIndex  index,
double *  deviation = NULL 
) const
virtual

Get a value for a TimeSerie or 0.0 if no value is found (no value for the interval) and, optionally, its deviation

Implements GKBaseObject.

◆ getDataValueObject()

virtual GKObject * GKSimulatedObject::getDataValueObject ( const GKColumn attr,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueObjectByID()

virtual GKObject * GKSimulatedObject::getDataValueObjectByID ( uint  attrId,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueString()

virtual QString GKSimulatedObject::getDataValueString ( const GKColumn attr,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueStringByID()

virtual QString GKSimulatedObject::getDataValueStringByID ( uint  attrId,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueTime()

virtual QTime GKSimulatedObject::getDataValueTime ( const GKColumn attr,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueTimeByID()

virtual QTime GKSimulatedObject::getDataValueTimeByID ( uint  attrId,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueTimeDuration()

virtual GKTimeDuration GKSimulatedObject::getDataValueTimeDuration ( const GKColumn attr,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueTimeDurationByID()

virtual GKTimeDuration GKSimulatedObject::getDataValueTimeDurationByID ( uint  attrId,
const GKContext context = GKContext::anyContext 
) const
virtual

◆ getDataValueTS()

virtual GKTimeSerie * GKSimulatedObject::getDataValueTS ( const GKColumn attr) const
virtual

Get a TimeSerie

Implements GKBaseObject.

◆ getDataValueTSByID()

virtual GKTimeSerie * GKSimulatedObject::getDataValueTSByID ( uint  attrId) const
virtual

Get a TimeSerie

Implements GKBaseObject.

◆ getDescription()

virtual const QString & GKSimulatedObject::getDescription ( ) const
virtual

Get the object description (entered by the user)

Implements GKBaseObject.

◆ getExternalId()

virtual const QString & GKSimulatedObject::getExternalId ( ) const
virtual

Get the object external ID stored in GKObject::externalIdAtt.

Implements GKBaseObject.

◆ getId()

virtual quint32 GKSimulatedObject::getId ( ) const
virtual

Return the unique identifier of this object.

Implements GKBaseObject.

Reimplemented in DTASection, and DTATurning.

◆ getMaster()

const GKObject * GKSimulatedObject::getMaster ( ) const
virtual

The object that originates this simulated object.

Implements GKBaseObject.

◆ getModel()

virtual GKModel * GKSimulatedObject::getModel ( ) const
virtual

Return the model of this object,

Implements GKBaseObject.

◆ getName()

virtual const QString & GKSimulatedObject::getName ( ) const
virtual

The optional name of this object.

Implements GKBaseObject.

◆ getType()

virtual GKType * GKSimulatedObject::getType ( ) const
virtual

Returns the master object's type. Refer to the getMaster() function to get the master object.

◆ getTypeExternalName()

virtual QString GKSimulatedObject::getTypeExternalName ( ) const
virtual

The type external name of the master object of this object. Refer to the getMaster() function to get the master object.

Implements GKBaseObject.

◆ isA() [1/2]

virtual bool GKSimulatedObject::isA ( const GKType atype) const
virtual

Returns true if the master object is an instance of a type (or a subtype of it). Refer to the getMaster() function to get the master object.

◆ isA() [2/2]

virtual bool GKSimulatedObject::isA ( const QString &  typeName) const
virtual

Returns true if this object is an instance of a type (or a subtype of it). Refer to the getMaster() function to get the master object.

◆ setMaster()

void GKSimulatedObject::setMaster ( GKObject master)

The object that originates this simulated object.

© Aimsun SLU
Aimsun ®