GKReplication Class Reference

Inheritance diagram for GKReplication:

Public Types
enum	GKSimulationMode {   eInteractive , eInteractiveAutoPlay , eBatch , eBatchIterative ,   eBatchExternal , eInteractiveExternal }
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
	GKReplication ()
uint	getDBId () const
void	setDBId (uint)
uint	getRandomSeed () const
void	setRandomSeed (uint)
GKExperiment *	getExperiment () const
void	setExperiment (GKExperiment *aexperiment)
const GKGenericExperiment::GKGenericExperimentStatus	getSimulationStatus () const
void	setSimulationStatus (const GKGenericExperiment::GKGenericExperimentStatus astatus)
bool	getUseExternalId () const
void	setUseExternalId (bool value)
bool	getSaveInitialState () const
void	setSaveInitialState (bool value)
GKDynamicTrafficSnapshot *	getSavedInitialState () const
void	setSavedInitialState (GKDynamicTrafficSnapshot *iniState)
bool	getGenerateTraversal () const
bool	getTraversalRoutes () const
void	setGenerateTraversal (bool value)
void	setTraversalRoutes (bool value)
GKProblemNet *	getTraversalSubnet () const
void	setTraversalSubnet (GKProblemNet *subnet)
void	enableVehiclesInBatch (bool value)
bool	isEnabledVehiclesInBatch () const
BaseForest *	getPathsForest () const
void	setPathsForest (BaseForest *forest)
bool	getRecordSimulation () const
void	setRecordSimulation (bool aRecordSimulation)
int	getRefreshRate () const
void	setRefreshRate (int aRefreshRate)
void	setInitSimulationTime (const QDateTime &time)
void	setEndSimulationTime (const QDateTime &time)
const QDateTime &	getInitSimulationTime () const
const QDateTime &	getEndSimulationTime () const
void	setSimulatorName (const QString &name)
void	setSimulatorVersion (const QString &name)
const QString &	getSimulatorName ()
const QString &	getSimulatorVersion ()
void	setStorePaths (bool storePaths)
void	setOutputPathAssignment (GKPathAssignment *aPathAssignment)
bool	getStorePaths () const
GKPathAssignment *	getOutputPathAssignment () const
void	setStoreTrafficArrivals (bool storeTrafficArrivals)
void	setOutputTrafficArrivals (GKTrafficArrivals *aTrafficArrivals)
bool	getStoreTrafficArrivals () const
GKTrafficArrivals *	getOutputTrafficArrivals () 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	dbIdAtt
static uint	randomSeedAtt
static uint	simulatorNameAtt
static uint	simulatorVersionAtt
static uint	initSimulationTimeAtt
static uint	endSimulationTimeAtt
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

GKSimulationMode

enum GKReplication::GKSimulationMode

Aimsun Next Simulator modes:

• eInteractive: Starts an interactive simulation. The simulation is stopped after simulating the transitory period.
• eInteractiveAutoPlay: Starts an interactive simulation and plays it.
• eBatch: Simulates a repliaction in batch. The user can only cancel the replication or waits until it ends.
• eBatchIterative: Batch mode using an iterative process to get equilibrium.
• eBatchExternal: Batch mode controlled by a external process.
• eInteractiveExternal: Simulates a replication in Interactive controlled by a external process.

Enumerator
eInteractive
eInteractiveAutoPlay
eBatch
eBatchIterative
eBatchExternal
eInteractiveExternal

Constructor & Destructor Documentation

GKReplication()

GKReplication::GKReplication

(

)

Member Function Documentation

enableVehiclesInBatch()

void GKReplication::enableVehiclesInBatch

(

bool

value

)

When running in batch mode GKSimVehicle objects are not created by default (to simulate faster). This call enables the creation in batch mode. Useful when creating attributes on these vehicles.

getDBId()

uint GKReplication::getDBId

(

)

const

Returns the replication ID (RID field) in the database. By default is the same as the replication identifier.

getEndSimulationTime()

const QDateTime & GKReplication::getEndSimulationTime

(

)

const

When this simulation ends. Note that this is the real time and not a simulated time. Use the init and the end time to know the required time to simulate this replication.

getExperiment()

GKExperiment * GKReplication::getExperiment

(

)

const

Returns the experiment where this replication is.

getGenerateTraversal()

bool GKReplication::getGenerateTraversal

(

)

const

returns whether the replication will generate a dynamic traveral

getInitSimulationTime()

const QDateTime & GKReplication::getInitSimulationTime

(

)

const

When this simulation was started. Note that this is the real time and not a simulated time. Use the init and the end time to know the required time to simulate this replication.

getOutputPathAssignment()

GKPathAssignment * GKReplication::getOutputPathAssignment

(

)

const

getOutputTrafficArrivals()

GKTrafficArrivals * GKReplication::getOutputTrafficArrivals

(

)

const

getPathsForest()

BaseForest * GKReplication::getPathsForest

(

)

const

Returns the current Forest if restored or simulated previously

getRandomSeed()

uint GKReplication::getRandomSeed

(

)

const

Gets the random seed. A seed is set when creating the object.

getRecordSimulation()

bool GKReplication::getRecordSimulation

(

)

const

Gets if the simulation is going to be recorded

getRefreshRate()

int GKReplication::getRefreshRate

(

)

const

Gets the refresh rate of the record simulation in Meso

getSavedInitialState()

GKDynamicTrafficSnapshot * GKReplication::getSavedInitialState

(

)

const

If getSaveInitialState() is true, returns the initial state to be stored or already stored at the end of the simulation. It return None otherwise.

getSaveInitialState()

bool GKReplication::getSaveInitialState

(

)

const

Returns wheter an initial state will be stored at the end of the simulation.

getSimulationStatus()

const GKGenericExperiment::GKGenericExperimentStatus GKReplication::getSimulationStatus

(

)

const

Gets the replication status. See GKReplicationSimulationStatus

getSimulatorName()

const QString & GKReplication::getSimulatorName

(

)

The simulator use to simulate this replication.

getSimulatorVersion()

const QString & GKReplication::getSimulatorVersion

(

)

The simulator version use to simulate this replication.

getStorePaths()

bool GKReplication::getStorePaths

(

)

const

getStoreTrafficArrivals()

bool GKReplication::getStoreTrafficArrivals

(

)

const

getTraversalRoutes()

bool GKReplication::getTraversalRoutes

(

)

const

returns whether the replication will provide OD Routes with the dynamic traversal

getTraversalSubnet()

GKProblemNet * GKReplication::getTraversalSubnet

(

)

const

returns the dynamic traversal subnetwork

getUseExternalId()

bool GKReplication::getUseExternalId

(

)

const

When restoring a replication data from a database: if true use the external ID of the objects to map the data to the current objects. If false (the default) it uses the identifier.

isEnabledVehiclesInBatch()

bool GKReplication::isEnabledVehiclesInBatch

(

)

const

When running in batch mode GKSimVehicle objects are not created by default (to simulate faster). This call enables the creation in batch mode. Useful when creating attributes on these vehicles.

setDBId()

void GKReplication::setDBId

(

uint

)

Sets the replication ID (RID field) in the database.

setEndSimulationTime()

void GKReplication::setEndSimulationTime

(

const QDateTime &

time

)

When this simulation ends. Note that this is the real time and not a simulated time. Use the init and the end time to know the required time to simulate this replication.

setExperiment()

void GKReplication::setExperiment

(

GKExperiment *

aexperiment

)

Sets the experiment where this replication is.

setGenerateTraversal()

void GKReplication::setGenerateTraversal

(

bool

value

)

sets whether the replication will generate a dynamic traversal

setInitSimulationTime()

void GKReplication::setInitSimulationTime

(

const QDateTime &

time

)

When this simulation was started. Note that this is the real time and not a simulated time. Use the init and the end time to know the required time to simulate this replication.

setOutputPathAssignment()

void GKReplication::setOutputPathAssignment

(

GKPathAssignment *

aPathAssignment

)

setOutputTrafficArrivals()

void GKReplication::setOutputTrafficArrivals

(

GKTrafficArrivals *

aTrafficArrivals

)

setPathsForest()

void GKReplication::setPathsForest

(

BaseForest *

forest

)

Set Forest

setRandomSeed()

void GKReplication::setRandomSeed

(

uint

)

Sets the random seed. A seed is set when creating the object.

setRecordSimulation()

void GKReplication::setRecordSimulation

(

bool

aRecordSimulation

)

Sets if the simulation is going to be recorded

setRefreshRate()

void GKReplication::setRefreshRate

(

int

aRefreshRate

)

Sets the refresh rate of the record simulation in Meso

setSavedInitialState()

void GKReplication::setSavedInitialState

(

GKDynamicTrafficSnapshot *

iniState

)

If getSaveInitialState() is true, sets the initial state to be stored at the end of the simulation.

setSaveInitialState()

void GKReplication::setSaveInitialState

(

bool

value

)

Sets wheter an initial state needs to be stored at the end of the simulation.

setSimulationStatus()

void GKReplication::setSimulationStatus

(

const GKGenericExperiment::GKGenericExperimentStatus

astatus

)

Sets the replication status. See GKReplicationSimulationStatus

setSimulatorName()

void GKReplication::setSimulatorName

(

const QString &

name

)

The simulator use to simulate this replication.

setSimulatorVersion()

void GKReplication::setSimulatorVersion

(

const QString &

name

)

The simulator version use to simulate this replication.

setStorePaths()

void GKReplication::setStorePaths

(

bool

storePaths

)

setStoreTrafficArrivals()

void GKReplication::setStoreTrafficArrivals

(

bool

storeTrafficArrivals

)

setTraversalRoutes()

void GKReplication::setTraversalRoutes

(

bool

value

)

sets whether the replication will provide OD Routes with the dynamic traversal

setTraversalSubnet()

void GKReplication::setTraversalSubnet

(

GKProblemNet *

subnet

)

sets the subnetwork where the dynamic traversal will be generated.

setUseExternalId()

void GKReplication::setUseExternalId

(

bool

value

)

When restoring a replication data from a database: if true use the external ID of the objects to map the data to the current objects. If false (the default) it uses the identifier.

Member Data Documentation

dbIdAtt

uint GKReplication::dbIdAtt

static

Replication identifier in the database

endSimulationTimeAtt

uint GKReplication::endSimulationTimeAtt

static

End simulation time. See GKReplication::setEndSimulationTime

initSimulationTimeAtt

uint GKReplication::initSimulationTimeAtt

static

Init simulation time. See GKReplication::setInitSimulationTime

randomSeedAtt

uint GKReplication::randomSeedAtt

static

Random seed

simulatorNameAtt

uint GKReplication::simulatorNameAtt

static

Simulator Name. See GKReplication::setSimulatorName

simulatorVersionAtt

uint GKReplication::simulatorVersionAtt

static

Simulator Version. See GKReplication::setSimulatorVersion