MacroExperiment Class Reference

Inheritance diagram for MacroExperiment:

Public Member Functions
	MacroExperiment ()
	~MacroExperiment ()
void	setEngine (QString name)
QString	getEngine () const
MacroScenario *	getScenario () const
MacroExperimentParams *	getParameters () const
void	setParameters (MacroExperimentParams *params)
MacroExperimentParams *	createParameters ()
CMacroStatsManager *	getStatsManager ()
void	setOutputPathAssignment (GKPathAssignment *aPathAssignment)
GKPathAssignment *	getOutputPathAssignment () const
void	setOutputPathAssignmentSubset (GKPathAssignment *aPathAssignment)
GKPathAssignment *	getOutputPathAssignmentSubset () const
MacroExperimentOutputData &	getOutputData ()
Public Member Functions inherited from GKGenericExperiment
	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 (GKScript *script)
void	setPostExecutionScript (GKScript *script)
GKScript *	getPreExecutionScript () 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) 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

Additional Inherited Members
Public Types inherited from GKGenericExperiment
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 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

Detailed Description

This class provides the basic variables of a macroexperiment. To create a new MacroExperiment the following code can be used assuming that target is a MacroScenario:

from PyMacroKernelPlugin import *
from PyFrankWolfePlugin import *
 
if target != None:
    cmd = model.createNewCmd( model.getType( "MacroExperiment" ))
    cmd.setScenario( target )
    cmd.setEngine( "FrankWolfe" )
    model.getCommander().addCommand( cmd )
    experiment = cmd.createdObject()
    params = experiment.getParameters()
    params.setMaxIterations ( 50 )
    params.setMaxRelativeGap ( 0.001 )
    params.setFrankWolfeMethod ( CFrankWolfeParams.eNormal )

Constructor & Destructor Documentation

MacroExperiment()

MacroExperiment::MacroExperiment

(

)

MacroExperiment constructor.

~MacroExperiment()

MacroExperiment::~MacroExperiment

(

)

MacroExperiment destructor.

Member Function Documentation

createParameters()

MacroExperimentParams * MacroExperiment::createParameters

(

)

Creates the experiment parameters. The engine needs to be previously set.

getEngine()

QString MacroExperiment::getEngine

(

)

const

Engine internal name

getOutputData()

MacroExperimentOutputData & MacroExperiment::getOutputData

(

)

Get the created output for the Macro Experiment

getOutputPathAssignment()

GKPathAssignment * MacroExperiment::getOutputPathAssignment

(

)

const

getOutputPathAssignmentSubset()

GKPathAssignment * MacroExperiment::getOutputPathAssignmentSubset

(

)

const

getParameters()

MacroExperimentParams * MacroExperiment::getParameters

(

)

const

Get the macro-experiment parameters.

getScenario()

MacroScenario * MacroExperiment::getScenario

(

)

const

Get the scenario of the macro experiment.

getStatsManager()

CMacroStatsManager * MacroExperiment::getStatsManager

(

)

Get the macro stats manager in order to view results.

setEngine()

void MacroExperiment::setEngine

(

QString

name

)

Engine internal name. For the Frank-Wolfe engine the name parameter has to be 'FrankWolfe'

setOutputPathAssignment()

void MacroExperiment::setOutputPathAssignment

(

GKPathAssignment *

aPathAssignment

)

setOutputPathAssignmentSubset()

void MacroExperiment::setOutputPathAssignmentSubset

(

GKPathAssignment *

aPathAssignment

)

setParameters()

void MacroExperiment::setParameters

(

MacroExperimentParams *

params

)

Set the macro-experiment parameters.