GKReplicationNewCmd Class Reference

Inheritance diagram for GKReplicationNewCmd:

Public Member Functions
	GKReplicationNewCmd ()
void	setAddToResult (bool value)
void	setExperiment (GKExperiment *anExperiment)
void	setResult (GKExperimentResult *aResult)
void	setData (int nbReplications, bool wantResult, bool externalIds, bool replicationsIds, int nbReplicationsIds)
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

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 replication would look like:

cmd = model.createNewCmd( model.getType( "GKReplication" ))
cmd.setExperiment( experiment )
model.getCommander().addCommand( cmd )
res = cmd.createdObject()

Constructor & Destructor Documentation

GKReplicationNewCmd()

GKReplicationNewCmd::GKReplicationNewCmd

(

)

Member Function Documentation

createdObject()

GKObject * GKReplicationNewCmd::createdObject ( ) const

virtual

Replication created or the first one is more than one has been created.

Reimplemented from GKCommand.

doit()

void GKReplicationNewCmd::doit ( )

virtual

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

Implements GKCommand.

setAddToResult()

void GKReplicationNewCmd::setAddToResult

(

bool

value

)

Add it to a result (to be part of a mean)?

setData()

void GKReplicationNewCmd::setData	(	int	nbReplications,
		bool	wantResult,
		bool	externalIds,
		bool	replicationsIds,
		int	nbReplicationsIds
	)

Function to specify the number of replications to be created, whether an average wants to be created or not, whether to user-define the replication IDs to be set as the database IDs and if so the starting ID. If the IDs on databse are not user-defined they will be the same as the replication's Aimsun internal IDs. The default behavior of the command is this function is not called will be similar as the one calling it like follows: replicationCmd.setData( 1, False, False, False, 0 )

setExperiment()

void GKReplicationNewCmd::setExperiment

(

GKExperiment *

anExperiment

)

In which experiment?

setResult()

void GKReplicationNewCmd::setResult

(

GKExperimentResult *

aResult

)

If the replication wants to be added to an existing average, the average needs to be specified calling this function.

undoit()

void GKReplicationNewCmd::undoit ( )

virtual

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

Implements GKCommand.