Aimsun Next Scripting: GKRealDataSet Class Reference
Aimsun Next Scripting  22
Public Types | Public Member Functions | List of all members
GKRealDataSet Class Reference
Inheritance diagram for GKRealDataSet:
GKObject GKBaseObject

Public Types

enum  ColType {
  eId , eTime , eVehicle , eCount ,
  eSpeed , eFlow , eReliability , eNotUsed ,
  eColumn , eCount_Min , eCount_Max , eCount_Dev ,
  eSpeed_Min , eSpeed_Max , eSpeed_Dev , eFlow_Min ,
  eFlow_Max , eFlow_Dev , eOccupancy , eCountInPCUs ,
  eBoarding , eAlighting , eDensity , ePTLoad ,
  eMaxQueue , eMeanQueue , eDelayTime , eStopTime ,
  eOccupancy_Min , eOccupancy_Max , eOccupancy_Dev
}
 
- 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::IdentifierFormFlagIdentifierForm
 

Public Member Functions

 GKRealDataSet ()
 
 ~GKRealDataSet ()
 
void clearRestorers ()
 
GKRealDataSetRestoreraddRestorer (const QString &)
 
const QVector< GKRealDataSetRestorer * > getRestorers () const
 
void addRestorer (GKRealDataSetRestorer *)
 
void removeRestorer (GKRealDataSetRestorer *)
 
bool restoreData ()
 
bool readed ()
 
GKRealDataSetFiltergetFilter ()
 
bool isValid (const QDateTime &atime, const GKGeoObject *obj) const
 
const QDateTime getFirstIntervalStartDate () const
 
const QDateTime getFirstIntervalEndDate () const
 
const QDateTime getLastIntervalStartDate () const
 
const QDateTime getLastIntervalEndDate () const
 
QVector< GKColumn * > getRelatedColumns () const
 
void addValue (ColType col, GKObject *obj, QString veh, QDateTime when, double value)
 
void addDev (ColType col, GKObject *obj, QString veh, QDateTime when, double value)
 
void addMin (ColType col, GKObject *obj, QString veh, QDateTime when, double value)
 
void addMax (ColType col, GKObject *obj, QString veh, QDateTime when, double value)
 
const GKTimeDurationgetInterval () const
 
QMap< QString, GKTSDescription * > getDescriptions () const
 
void setDescriptions (QMap< QString, GKTSDescription * > desc)
 
void clearDescriptions ()
 
QDateTime getBaseDate () const
 
void setBaseDate (const QDateTime &value)
 
GKObjectclone (bool addItToModel=true) 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 GKObjectclone (bool addItToModel=true) const
 
virtual GKObjectcloneAsTemporary (bool addItToModel=true) const
 
GKFoldergetCreateRootFolder ()
 
GKFoldergetRootFolder () const
 
void setRootFolder (GKFolder *afolder)
 
GKFolderfindFolder (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 GKTimeSeriegetDataValueTS (const GKColumn *attr) const
 
GKTimeSeriegetDataValueTSByID (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 GKObjectgetDataValueObject (const GKColumn *attr, const GKContext &context=GKContext::anyContext) const
 
GKObjectgetDataValueObjectByID (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 GKObjectgetMaster () const
 
GKTypegetType () const
 
virtual void setType (GKType *atype)
 
bool isA (const GKType *atype) const
 
bool isA (const QString &typeName) const
 
virtual void setModel (GKModel *amodel)
 
GKModelgetModel () 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 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 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
 

Detailed Description

A GKRealDataSet is a collection of objects (GKRealDataSetRestorer) that can read external detection data into GKTimeSeries.

The GKRealDataSetRestorer can be from ASCII files, relational databases, online data... A developer can create new restorers for any kind of data format and information source.

Data can be filtered either by time and/or bu area using a GKRealDataSetFilter

Member Enumeration Documentation

◆ ColType

Possible column types in an external source. eColumn is an already defined column in the object.

Enumerator
eId 
eTime 
eVehicle 
eCount 
eSpeed 
eFlow 
eReliability 
eNotUsed 
eColumn 
eCount_Min 
eCount_Max 
eCount_Dev 
eSpeed_Min 
eSpeed_Max 
eSpeed_Dev 
eFlow_Min 
eFlow_Max 
eFlow_Dev 
eOccupancy 
eCountInPCUs 
eBoarding 
eAlighting 
eDensity 
ePTLoad 
eMaxQueue 
eMeanQueue 
eDelayTime 
eStopTime 
eOccupancy_Min 
eOccupancy_Max 
eOccupancy_Dev 

Constructor & Destructor Documentation

◆ GKRealDataSet()

GKRealDataSet::GKRealDataSet ( )

◆ ~GKRealDataSet()

GKRealDataSet::~GKRealDataSet ( )

Member Function Documentation

◆ addDev()

void GKRealDataSet::addDev ( ColType  col,
GKObject obj,
QString  veh,
QDateTime  when,
double  value 
)

Adds a deviation value to the RDS time series.

◆ addMax()

void GKRealDataSet::addMax ( ColType  col,
GKObject obj,
QString  veh,
QDateTime  when,
double  value 
)

Adds a Maximum value to the RDS time series.

◆ addMin()

void GKRealDataSet::addMin ( ColType  col,
GKObject obj,
QString  veh,
QDateTime  when,
double  value 
)

Adds a minimum value to the RDS time series.

◆ addRestorer() [1/2]

GKRealDataSetRestorer * GKRealDataSet::addRestorer ( const QString &  )

Adds a new restorer using its type name and returns a reference to it.

◆ addRestorer() [2/2]

void GKRealDataSet::addRestorer ( GKRealDataSetRestorer )

Add a restorer. The pointer is adopted.

◆ addValue()

void GKRealDataSet::addValue ( ColType  col,
GKObject obj,
QString  veh,
QDateTime  when,
double  value 
)

Adds a value to the RDS time series.

◆ clearDescriptions()

void GKRealDataSet::clearDescriptions ( )

Clear all descriptions.

◆ clearRestorers()

void GKRealDataSet::clearRestorers ( )

Removes (and deletes) all the restorers in this data set.

◆ clone()

GKObject * GKRealDataSet::clone ( bool  addItToModel = true) const
virtual

Returns this object copied in a new one.

Reimplemented from GKObject.

◆ getBaseDate()

QDateTime GKRealDataSet::getBaseDate ( ) const

Returns the Base Date. It is only relevant on Relative Time types.

◆ getDescriptions()

QMap< QString, GKTSDescription * > GKRealDataSet::getDescriptions ( ) const

◆ getFilter()

GKRealDataSetFilter & GKRealDataSet::getFilter ( )

Returns the filter.

◆ getFirstIntervalEndDate()

const QDateTime GKRealDataSet::getFirstIntervalEndDate ( ) const

First interval end date (available after a restoreData)

◆ getFirstIntervalStartDate()

const QDateTime GKRealDataSet::getFirstIntervalStartDate ( ) const

First interval start date (available after a restoreData)

◆ getInterval()

const GKTimeDuration & GKRealDataSet::getInterval ( ) const

Interval as set using GKRealDataSetRestorer::insertLines

◆ getLastIntervalEndDate()

const QDateTime GKRealDataSet::getLastIntervalEndDate ( ) const

Last interval end date (available after a restoreData)

◆ getLastIntervalStartDate()

const QDateTime GKRealDataSet::getLastIntervalStartDate ( ) const

Last interval start date (available after a restoreData)

◆ getRelatedColumns()

QVector< GKColumn * > GKRealDataSet::getRelatedColumns ( ) const

Returns the columns that have been created when restoring this real data set

◆ getRestorers()

const QVector< GKRealDataSetRestorer * > GKRealDataSet::getRestorers ( ) const

Returns all the restorers in this data set.

◆ isValid()

bool GKRealDataSet::isValid ( const QDateTime &  atime,
const GKGeoObject obj 
) const

Returns true if the data is between the from a to times the object filtered areas.

It returns true is we are not filtering by data or area (any date or area is OK then).

◆ readed()

bool GKRealDataSet::readed ( )

Returns true if any data has been read using restoreData

◆ removeRestorer()

void GKRealDataSet::removeRestorer ( GKRealDataSetRestorer )

Removes a restorer from this data set. The restorer is not deleted.

◆ restoreData()

bool GKRealDataSet::restoreData ( )

Read external data to memory. Returns true if all the data is correctly restored. If a restorer fails the restoration is aborted.

◆ setBaseDate()

void GKRealDataSet::setBaseDate ( const QDateTime &  value)

Sets the Base Date. It is only relevant on Relative Time types.

◆ setDescriptions()

void GKRealDataSet::setDescriptions ( QMap< QString, GKTSDescription * >  desc)

© Aimsun SLU
Aimsun ®