Aimsun Next Scripting  24.0
Public Member Functions | List of all members
GKGroupNewCmd Class Reference
Inheritance diagram for GKGroupNewCmd:

Public Member Functions

 GKGroupNewCmd ()
 
void setGroupingType (GKGroupingType *aGroupingType)
 
GKObjectcreatedObject () const
 
void doit ()
 
void undoit ()
 

Detailed Description

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:93
Type information for an object.
Definition: GKType.sip:194

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:30

from the GKCommander class.

See also
GKCommander::addCommand

A sample code for creating a new group would look like:

cmd = model.createNewCmd( model.getType( "GKGroup" ))
cmd.setGroupingType( groupingType )
model.getCommander().addCommand( cmd )
res = cmd.createdObject()

Constructor & Destructor Documentation

◆ GKGroupNewCmd()

GKGroupNewCmd::GKGroupNewCmd ( )

Member Function Documentation

◆ createdObject()

GKObject * GKGroupNewCmd::createdObject ( ) const

Group created.

◆ doit()

void GKGroupNewCmd::doit ( )

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

◆ setGroupingType()

void GKGroupNewCmd::setGroupingType ( GKGroupingType aGroupingType)

In which grouping type?

◆ undoit()

void GKGroupNewCmd::undoit ( )

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

© Aimsun SLU
Aimsun ®