Aimsun Next Scripting  22
Public Member Functions | List of all members
ModalSplitExperimentNewCmd Class Reference
Inheritance diagram for ModalSplitExperimentNewCmd:
GKCommand

Public Member Functions

 ModalSplitExperimentNewCmd ()
 
 ~ModalSplitExperimentNewCmd ()
 
void setScenario (ModalSplitScenario *ascenario)
 
GKObjectcreatedObject () 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 *)
 
GKModelgetModel () const
 
virtual GKCommandReportinit (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 GKObjectcreatedObject () const
 
virtual bool createdObjectRequiresEdition () const
 
virtual QVector< int > getTargets () const
 

Additional Inherited Members

- Public Attributes inherited from GKCommand
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS GKCommandbase = (GKCommand*)sipCpp
 
 sipType = 0
 

Detailed Description

Command to create a new Modal Split Experiment inside a Modal Split Scenario.

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

GKCommand * createNewCmd( GKType * type ) const;
Base class for all the commands (except Delete commands, see GKObjectDelCmd, or Cut commands see GKOb...
Definition: GKCommand.sip:92
Type information for an object.
Definition: GKType.sip:193

from the GKModel class.

See also
GKModel::createNewCmd

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

GKCommandReport * addCommand( GKCommand * aCommand );
An error during a command execution.
Definition: GKCommand.sip:29

from the GKCommander class.

See also
GKCommander::addCommand

A sample code for creating a new Modal Split Experiment would look like:

cmd = model.createNewCmd( model.getType( "ModalSplitExperiment" ))
cmd.setScenario( scenario )
model.getCommander().addCommand( cmd )
res = cmd.createdObject()

Constructor & Destructor Documentation

◆ ModalSplitExperimentNewCmd()

ModalSplitExperimentNewCmd::ModalSplitExperimentNewCmd ( )

◆ ~ModalSplitExperimentNewCmd()

ModalSplitExperimentNewCmd::~ModalSplitExperimentNewCmd ( )

Member Function Documentation

◆ createdObject()

GKObject * ModalSplitExperimentNewCmd::createdObject ( ) const
virtual

Returns the created Modal Split Experiment once the command has been done.

Reimplemented from GKCommand.

◆ doit()

void ModalSplitExperimentNewCmd::doit ( )
virtual

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

Implements GKCommand.

◆ setScenario()

void ModalSplitExperimentNewCmd::setScenario ( ModalSplitScenario ascenario)

Sets the Modal Split Scenario that will contain the Modal Split Experiment to create.

◆ undoit()

void ModalSplitExperimentNewCmd::undoit ( )
virtual

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

Implements GKCommand.

© Aimsun SLU
Aimsun ®