Aimsun Next Scripting: GKBaseObject Class Reference
Aimsun Next Scripting  22
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
GKBaseObject Class Referenceabstract
Inheritance diagram for GKBaseObject:
GKObject GKSimulatedObject DTAIterativeSimulationResultData DetectorLocation GKAuthority GKCentroidConfiguration GKControlJunction GKControlPlan GKControlPlanSignal GKDetectionPattern GKDistributionCentroidType GKDistributionDataSet GKDynamicTrafficSnapshot GKFolder GKFunctionComponent GKFunctionCost GKGenerationAttractionCentroidType GKGenerationAttractionDataSet GKGenerationAttractionDataSetAttribute GKGenerationAttractionVector GKGenericExperiment GKGenericScenario GKGeoObject GKGeometryConfiguration GKGroupingType GKLaneType GKMasterControlPlan GKMobileAgent GKModel GKNetworkAttributesOverride GKPTZonePlan GKParkingCentroidType GKPathAssignment GKPathAssignmentPlan GKPrintLayout GKProblem GKPublicLinePlan GKPublicLineTimeTable GKPublicLineTimeTableSchedule GKRealDataSet GKReplication GKRoadType GKScenarioChange GKScript GKSimulationEvent GKStrategy GKTimePeriod GKTrafficArrivals GKTrafficDemand GKTrafficDemandItem GKTrafficProfile GKTransportationMode GKTrigger GKTripPurpose GKUserClass GKVehicleClass GKViewBookmark GKViewMode GKViewModeStyle CMacroConnection CMacroSection CMacroTrajectory CMacroTurning CMacroUserClass DTASection DTATurning DTAUserClass DTAVehicleType PTStation

Public Member Functions

 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

ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObjectbase = (GKBaseObject*)sipCpp
 
 sipType = 0
 

Static Public Attributes

Py_END_ALLOW_THREADS static End uint idAtt
 
static uint nameAtt
 
static uint externalIdAtt
 
static uint descriptionAtt
 

Detailed Description

See also
GKObjects
GKSimulatedObject

Constructor & Destructor Documentation

◆ GKBaseObject()

GKBaseObject::GKBaseObject ( )

Member Function Documentation

◆ getDataValue()

virtual QVariant * GKBaseObject::getDataValue ( const GKColumn attr,
bool *  deleteit,
const GKContext context = GKContext::anyContext 
) const
pure 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.

Implemented in GKObject, and GKSimulatedObject.

◆ getDataValueBool()

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

◆ getDataValueBoolByID()

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

◆ getDataValueByID()

virtual QVariant * GKBaseObject::getDataValueByID ( uint  attrId,
bool *  deleteit,
const GKContext context = GKContext::anyContext 
) const
pure 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.

Implemented in GKObject, and GKSimulatedObject.

◆ getDataValueDate()

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

◆ getDataValueDateByID()

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

◆ getDataValueDateTime()

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

◆ getDataValueDateTimeByID()

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

◆ getDataValueDouble()

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

◆ getDataValueDoubleByID()

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

◆ getDataValueInt()

virtual int GKBaseObject::getDataValueInt ( const GKColumn attr,
const GKContext context = GKContext::anyContext 
) const
pure 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

Implemented in GKSection, GKForceEnrouteAssignment, GKObject, and GKSimulatedObject.

◆ getDataValueIntByID()

virtual int GKBaseObject::getDataValueIntByID ( uint  attrId,
const GKContext context = GKContext::anyContext 
) const
pure 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

Implemented in GKObject, and GKSimulatedObject.

◆ getDataValueInTS()

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

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

Implemented in GKObject, and GKSimulatedObject.

◆ getDataValueInTSByID()

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

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

Implemented in GKObject, and GKSimulatedObject.

◆ getDataValueObject()

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

◆ getDataValueObjectByID()

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

◆ getDataValueString()

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

◆ getDataValueStringByID()

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

◆ getDataValueTime()

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

◆ getDataValueTimeByID()

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

◆ getDataValueTimeDuration()

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

◆ getDataValueTimeDurationByID()

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

◆ getDataValueTS()

virtual GKTimeSerie * GKBaseObject::getDataValueTS ( const GKColumn attr) const
pure virtual

Get a TimeSerie

Implemented in GKObject, and GKSimulatedObject.

◆ getDataValueTSByID()

virtual GKTimeSerie * GKBaseObject::getDataValueTSByID ( uint  attrId) const
pure virtual

Get a TimeSerie

Implemented in GKObject, and GKSimulatedObject.

◆ getDescription()

virtual const QString & GKBaseObject::getDescription ( ) const
pure virtual

Get the object description (entered by the user)

Implemented in GKObject, and GKSimulatedObject.

◆ getExternalId()

virtual const QString & GKBaseObject::getExternalId ( ) const
pure virtual

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

Implemented in GKObject, and GKSimulatedObject.

◆ getId()

virtual uint GKBaseObject::getId ( ) const
pure virtual

Return the unique identifier of this object.

Implemented in DTASection, DTATurning, GKObject, and GKSimulatedObject.

◆ getMaster()

virtual const GKObject * GKBaseObject::getMaster ( ) const
pure virtual

The object that originates this object

Implemented in GKObject, and GKSimulatedObject.

◆ getModel()

virtual GKModel * GKBaseObject::getModel ( ) const
pure virtual

Return the model of this object,

Implemented in GKObject, and GKSimulatedObject.

Referenced by if().

◆ getName()

virtual const QString & GKBaseObject::getName ( ) const
pure virtual

The optional name of this object.

Implemented in GKObject, and GKSimulatedObject.

◆ getTypeExternalName()

virtual QString GKBaseObject::getTypeExternalName ( ) const
pure virtual

The type external name of this object. Is equivalent to getType()->getExternalName()

Implemented in GKObject, and GKSimulatedObject.

◆ getTypeName()

virtual const QString & GKBaseObject::getTypeName ( ) const
pure virtual

The type name of this object

Implemented in DTAUserClass, GKObject, CMacroConnection, CMacroSection, CMacroTrajectory, CMacroTurning, and CMacroUserClass.

Referenced by if().

◆ if()

GKBaseObject::if ( base  )
inline

Member Data Documentation

◆ base

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

Referenced by if().

◆ descriptionAtt

uint GKBaseObject::descriptionAtt
static

Object Description as an attribute.

◆ externalIdAtt

uint GKBaseObject::externalIdAtt
static

Object External ID as an attribute.

◆ idAtt

Py_END_ALLOW_THREADS static End uint GKBaseObject::idAtt
static

Object Identifier as an attribute.

◆ nameAtt

uint GKBaseObject::nameAtt
static

Object Name as an attribute.

◆ sipType

GKBaseObject::sipType = 0

Referenced by if().

© Aimsun SLU
Aimsun ®