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

Public Member Functions

 GKGroupFromPolygonNewCmd ()
 
virtual ~GKGroupFromPolygonNewCmd ()
 
void setData (const QList< GKPolygon * > &polygons, GKGroupingType *grouping)
 
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

The command creates a new GKGroup object from a given GKPolygon area. The new object will be placed initially into the selected grouping.

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" ))
smd.setData( polygons, groupingType )
model.getCommander().addCommand( cmd )
res = cmd.createdObject()

Constructor & Destructor Documentation

◆ GKGroupFromPolygonNewCmd()

GKGroupFromPolygonNewCmd::GKGroupFromPolygonNewCmd ( )

◆ ~GKGroupFromPolygonNewCmd()

virtual GKGroupFromPolygonNewCmd::~GKGroupFromPolygonNewCmd ( )
virtual

Member Function Documentation

◆ createdObject()

GKObject * GKGroupFromPolygonNewCmd::createdObject ( ) const
virtual

Created object for New Commands (once the command has been added to the GKCommander via the addCommand function).

Reimplemented from GKCommand.

◆ doit()

void GKGroupFromPolygonNewCmd::doit ( )
virtual

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

Implements GKCommand.

◆ setData()

void GKGroupFromPolygonNewCmd::setData ( const QList< GKPolygon * > &  polygons,
GKGroupingType grouping 
)

Initializes the class with the polygon to use.

◆ undoit()

void GKGroupFromPolygonNewCmd::undoit ( )
virtual

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

Implements GKCommand.

© Aimsun SLU
Aimsun ®