MacroPTExperimentNewCmd Class Reference

Inheritance diagram for MacroPTExperimentNewCmd:

Public Member Functions
	MacroPTExperimentNewCmd ()
	~MacroPTExperimentNewCmd ()
void	setScenario (MacroPTScenario *ascenario)
void	setEngine (QString engineName)
void	setAlgorithm (const QString &algorithmName)
GKObject *	createdObject () const
void	doit ()
void	undoit ()
Public Member Functions inherited from GKCommand
	if (base)
Py_END_ALLOW_THREADS End	GKCommand ()
void	setName (const QString &)
const QString &	getName () const
void	setModel (GKModel *)
GKModel *	getModel () const
virtual GKCommandReport *	init (GKModel *)
virtual bool	isEqual (GKCommand *) const
virtual void	merge (GKCommand *)
virtual void	doit ()=0
virtual void	undoit ()=0
void	setUndoable (bool)
bool	isUndoable () const
bool	isDone () const
virtual void	setDone (bool)
virtual void	commandToBeDone ()
virtual void	commandDone ()
virtual void	commandToBeUndone ()
virtual void	commandUndone ()
virtual GKObject *	createdObject () const
virtual bool	createdObjectRequiresEdition () const
virtual QVector< int >	getTargets () const

Additional Inherited Members
Public Attributes inherited from GKCommand
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKCommand *	base = (GKCommand*)sipCpp
	sipType = 0

Detailed Description

Command to create a new macro transit experiment inside a macro transit scenario

The correct way to create this command is to use the function:

GKCommand * createNewCmd( GKType * type ) const;

from the GKModel class.

See also

GKModel::createNewCmd

Once created, and in order to do it use the function:

GKCommandReport * addCommand( GKCommand * aCommand );

from the GKCommander class.

See also

GKCommander::addCommand

A sample code for creating a new Macro transit Experiment would look like:

cmd = model.createNewCmd( model.getType( "MacroPTExperiment" ))
cmd.setScenario( scenario )
cmd.setEngine( "PTFrequencyBased" )
cmd.setAlgorithm( "FrankWolfe" )
model.getCommander().addCommand( cmd )
res = cmd.createdObject()

Constructor & Destructor Documentation

MacroPTExperimentNewCmd()

MacroPTExperimentNewCmd::MacroPTExperimentNewCmd

(

)

~MacroPTExperimentNewCmd()

MacroPTExperimentNewCmd::~MacroPTExperimentNewCmd

(

)

Member Function Documentation

createdObject()

GKObject * MacroPTExperimentNewCmd::createdObject ( ) const

virtual

Returns the created macro experiment once the command has been done.

Reimplemented from GKCommand.

doit()

void MacroPTExperimentNewCmd::doit ( )

virtual

Do not use this function. Available just for compatibility issues.

Implements GKCommand.

setAlgorithm()

void MacroPTExperimentNewCmd::setAlgorithm

(

const QString &

algorithmName

)

Sets the algorithm that will be used by the macro transit experiment. The available algorithms are:

• AllOrNothing.
• MSA.
• FrankWolfe.

setEngine()

void MacroPTExperimentNewCmd::setEngine

(

QString

engineName

)

Sets the engine that will be used by the macro transit experiment. The available engines are:

• PTFrequencyBased.

setScenario()

void MacroPTExperimentNewCmd::setScenario

(

MacroPTScenario *

ascenario

)

Sets the macro transit scenario that will contain the macro transit experiment to create

undoit()

void MacroPTExperimentNewCmd::undoit ( )

virtual

Do not use this function. Available just for compatibility issues.

Implements GKCommand.