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

Public Member Functions

 GKPedestrianLevelChangeObjectNewCmd ()
 
void setPoints (const GKPoints &points)
 
GKObjectcreatedObject () const
 
GKCommandReportinit (GKModel *amodel)
 
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

Creates a Pedestrian Level Change Object. 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 Pedestrian Level Change Object would look like:

cmd = model.createNewCmd( model.getType( "GKPedestrianLevelChangeObject" ))
cmd.setPoints( points )
cmd.init( model )
model.getCommander().addCommand( cmd )
res = cmd.createdObject()

Constructor & Destructor Documentation

◆ GKPedestrianLevelChangeObjectNewCmd()

GKPedestrianLevelChangeObjectNewCmd::GKPedestrianLevelChangeObjectNewCmd ( )

Member Function Documentation

◆ createdObject()

GKObject * GKPedestrianLevelChangeObjectNewCmd::createdObject ( ) const
virtual

Created pedestrian area (doit required).

Reimplemented from GKCommand.

◆ doit()

void GKPedestrianLevelChangeObjectNewCmd::doit ( )
virtual

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

Implements GKCommand.

◆ init()

GKCommandReport * GKPedestrianLevelChangeObjectNewCmd::init ( GKModel )
virtual

Initializes the command and returns NULL if the command can be executed, othewise it returns information about why the command cannot be executed. This method is called by GKCommander when the command is added to it (GKCommander::add) and before it is executed.

Reimplemented from GKCommand.

◆ setPoints()

void GKPedestrianLevelChangeObjectNewCmd::setPoints ( const GKPoints points)

◆ undoit()

void GKPedestrianLevelChangeObjectNewCmd::undoit ( )
virtual

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

Implements GKCommand.

© Aimsun SLU
Aimsun ®