Inheritance diagram for GKGenericExperiment:
Public Types | |
| enum | GKGenericExperimentStatus { ePending , eDone , eDiscarded , eLoaded } |
 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 | |
| GKGenericExperiment () | |
| virtual GKGenericExperimentStatus | getExecutionStatus () const |
| void | setValueForVariable (const QString &variable, const QString &value) |
| bool | removeVariable (const QString &variable) |
| const QString & | getValueForVariable (const QString &variable) const |
| const QMap< QString, QString > & | getVariables () const |
| void | setVariables (const QMap< QString, QString > &newList) |
| void | setScenario (GKGenericScenario *anScenario) |
| GKGenericScenario * | getScenario () const |
| void | setForest (BaseForest *_forest, bool _delete=true) |
| const BaseForest * | getForest () const |
| void | addNetworkAttributesOverride (GKNetworkAttributesOverride *ovrd, int pos=-1) |
| void | removeNetworkAttributesOverride (GKNetworkAttributesOverride *ovrd) |
| void | clearNetworkAttributesOverrides () |
| const QVector< GKNetworkAttributesOverride * > & | getNetworkAttributesOverrides () const |
| int | usesNetworkAttributesOverride (const GKNetworkAttributesOverride *ovrd) const |
| void | setPreExecutionScript (const GKScript *script) |
| void | setPostExecutionScript (const GKScript *script) |
| const GKScript * | getPreExecutionScript () const |
| const GKScript * | getPostExecutionScript () const |
| QString | getOutputFile (const QString &iType) const |
| void | addPolicy (GKPolicy *) |
| void | removePolicy (GKPolicy *) |
| void | removePolicies () |
| const QVector< GKPolicy * > & | getPolicies () const |
| bool | usesPolicy (GKPolicy *) const |
| bool | canPolicyBeUsed (GKPolicy *) const |
| const QDateTime & | getInitExecutionTime () const |
| const QDateTime & | getEndExecutionTime () 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, bool temporary=false) const |
| 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, unsigned int index, double *deviation=nullptr) const |
| double | getDataValueInTSByID (uint attrId, unsigned int index, double *deviation=nullptr) const |
| bool | hasAnyTSWithData () const |
| virtual GKTimeSerie * | getDataValueTS (const GKColumn *attr) const |
| GKTimeSerie * | getDataValueTSByID (uint attrId) const |
| virtual void | setDataValueInTS (const GKColumn *attr, unsigned int index, double value, double deviation, GKTSDescription *aDescription=nullptr) |
| virtual void | setDataValueInTS (const GKColumn *attr, unsigned int index, double value, double deviation, double lowerValue, GKTSDescription *aDescription=nullptr) |
| void | setDataValueInTSByID (uint attrId, unsigned int index, double value, double deviation, GKTSDescription *aDescription=nullptr) |
| void | setDataValueInExpandableTSByID (uint attrId, double value, double deviation, GKTSDescription *aDescription=nullptr) |
| virtual void | setAggregatedValueInTS (const GKColumn *attr, double value, double deviation, GKTSDescription *aDescription=NULL) |
| void | setAggregatedValueInTSByID (uint attrId, double value, double deviation, GKTSDescription *aDescription=NULL) |
| GKTimeSerie * | createDataValueTS (const GKColumn *attr, GKTSDescription *aDescription) |
| virtual void | clearDataValueTS (const GKColumn *attr) |
| void | clearDataValueTSByID (uint attrId) |
| 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, unsigned int index, double *deviation=NULL) const =0 |
| virtual double | getDataValueInTSByID (uint attrId, unsigned int index, double *deviation=nullptr) 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 |
Additional Inherited Members | |
| Public Attributes inherited from GKBaseObject | |
| ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKBaseObject * | base = (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 |
Member Enumeration Documentation
◆ GKGenericExperimentStatus
Status of an execution:
- ePending: not yet executed
- eDone: executed
- eDiscarded: not usable (wrong results maybe)
- eLoaded: data in memory (after an execution or after reading data from the database).
For replications or macro results it will be the real status. For experiments it will be the status of the average (or DUE or macro experiment result) status.
| Enumerator | |
|---|---|
| ePending | |
| eDone | |
| eDiscarded | |
| eLoaded | |
Constructor & Destructor Documentation
◆ GKGenericExperiment()
| GKGenericExperiment::GKGenericExperiment | ( | ) |
Member Function Documentation
◆ addNetworkAttributesOverride()
| void GKGenericExperiment::addNetworkAttributesOverride | ( | GKNetworkAttributesOverride * | ovrd, |
| int | pos = -1 |
||
| ) |
Adds / inserts a simulation settings object to this experiment in the given position (-1: added to the end)
◆ addPolicy()
| void GKGenericExperiment::addPolicy | ( | GKPolicy * | ) |
Add a policy to be use in this experiment.
◆ canPolicyBeUsed()
| bool GKGenericExperiment::canPolicyBeUsed | ( | GKPolicy * | ) | const |
Is this policy available? It is in the list of available policies in this experiment but maybe the associated strategy is not active in the scenario.
◆ clearNetworkAttributesOverrides()
| void GKGenericExperiment::clearNetworkAttributesOverrides | ( | ) |
Removes all simulation settings objects from this experiment.
◆ getEndExecutionTime()
| const QDateTime & GKGenericExperiment::getEndExecutionTime | ( | ) | const |
When the execution of this experiment 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 experiment.
◆ getExecutionStatus()
|
virtual |
Returns the status of this experiment based on the result on it (Average, DUE...)
◆ getForest()
| const BaseForest * GKGenericExperiment::getForest | ( | ) | const |
Gets the contained NSPForest
◆ getInitExecutionTime()
| const QDateTime & GKGenericExperiment::getInitExecutionTime | ( | ) | const |
When the execution of this experiment 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 execute this experiment.
◆ getNetworkAttributesOverrides()
| const QVector< GKNetworkAttributesOverride * > & GKGenericExperiment::getNetworkAttributesOverrides | ( | ) | const |
Returns the simulation areas in this experiment.
◆ getOutputFile()
| QString GKGenericExperiment::getOutputFile | ( | const QString & | iType | ) | const |
Get the output file for specified type
◆ getPolicies()
| const QVector< GKPolicy * > & GKGenericExperiment::getPolicies | ( | ) | const |
Returns the policies in this experiment.
◆ getPostExecutionScript()
| const GKScript * GKGenericExperiment::getPostExecutionScript | ( | ) | const |
Script to execute after the execution of this experiment
◆ getPreExecutionScript()
| const GKScript * GKGenericExperiment::getPreExecutionScript | ( | ) | const |
Script to execute before the execution of this experiment
◆ getScenario()
| GKGenericScenario * GKGenericExperiment::getScenario | ( | ) | const |
Returns the scenario this experiment belongs to
◆ getValueForVariable()
| const QString & GKGenericExperiment::getValueForVariable | ( | const QString & | variable | ) | const |
Returns the value of a variable. If the variable is not defined it will return QString().
If the variable is not really a variable then it will be returned as is.
◆ getVariables()
| const QMap< QString, QString > & GKGenericExperiment::getVariables | ( | ) | const |
Returns all the variables in this scenario and its values.
◆ removeNetworkAttributesOverride()
| void GKGenericExperiment::removeNetworkAttributesOverride | ( | GKNetworkAttributesOverride * | ovrd | ) |
Removes a simulation settings object from this experiment.
- Warning
- The specified simulation settings MUST be one of the experiment's simulation settings.
◆ removePolicies()
| void GKGenericExperiment::removePolicies | ( | ) |
Removes all policies from this experiment.
◆ removePolicy()
| void GKGenericExperiment::removePolicy | ( | GKPolicy * | ) |
Removes a policy from this experiment.
◆ removeVariable()
| bool GKGenericExperiment::removeVariable | ( | const QString & | variable | ) |
Removes the variable (first argument) from this experiment. Returns true if the variable was found false otherwise.
◆ setForest()
| void GKGenericExperiment::setForest | ( | BaseForest * | _forest, |
| bool | _delete = true |
||
| ) |
Sets the NSPForest Output (This pointer is adopted). Used for static assignments. Dynamic assignents will have this information in the replication.
◆ setPostExecutionScript()
| void GKGenericExperiment::setPostExecutionScript | ( | const GKScript * | script | ) |
Script to execute after the execution of this experiment
◆ setPreExecutionScript()
| void GKGenericExperiment::setPreExecutionScript | ( | const GKScript * | script | ) |
Script to execute before the execution of this experiment
◆ setScenario()
| void GKGenericExperiment::setScenario | ( | GKGenericScenario * | anScenario | ) |
Sets, at creation time, the scenario for this experiment. It cannot be changed later on.
◆ setValueForVariable()
| void GKGenericExperiment::setValueForVariable | ( | const QString & | variable, |
| const QString & | value | ||
| ) |
Sets the value (second argument) for a variable (first argument) in this scenario.
◆ setVariables()
| void GKGenericExperiment::setVariables | ( | const QMap< QString, QString > & | newList | ) |
Sets all the variables in this scenario and its values.
◆ usesNetworkAttributesOverride()
| int GKGenericExperiment::usesNetworkAttributesOverride | ( | const GKNetworkAttributesOverride * | ovrd | ) | const |
Returns the position of the given simulation settings object inside the experiment list, or -1 if not used.
◆ usesPolicy()
| bool GKGenericExperiment::usesPolicy | ( | GKPolicy * | ) | const |
Returns true is the policy is used in the experiment.
