Aimsun Next Scripting  22
Public Member Functions | List of all members
GKKernelAction Class Referenceabstract
Inheritance diagram for GKKernelAction:
GKObjectKernelAction

Public Member Functions

 GKKernelAction ()
 
virtual ~GKKernelAction ()
 
virtual QVector< GKKernelActionEntrygetActions (GKObject *target=nullptr) const =0
 
virtual bool canExecute (QVector< GKObject * > target, QString id) const =0
 
virtual bool execute (QVector< GKObject * > target, QString id, QString taskId)=0
 
virtual QString getTaskId () const
 

Detailed Description

This class is the non-GUI equivalent of the GKActionMenu

Constructor & Destructor Documentation

◆ GKKernelAction()

GKKernelAction::GKKernelAction ( )

GKKernelAction constructor.

◆ ~GKKernelAction()

virtual GKKernelAction::~GKKernelAction ( )
virtual

GKKernelAction destructor.

Member Function Documentation

◆ canExecute()

virtual bool GKKernelAction::canExecute ( QVector< GKObject * >  target,
QString  id 
) const
pure virtual

Tests if an action can be executed (the selection is valid, the action exists, the resources are available...)

Implemented in GKObjectKernelAction.

◆ execute()

virtual bool GKKernelAction::execute ( QVector< GKObject * >  target,
QString  id,
QString  taskId 
)
pure virtual

Executes a kernel action over a set of objects. Returns true if the action was found.

Implemented in GKObjectKernelAction.

◆ getActions()

virtual QVector< GKKernelActionEntry > GKKernelAction::getActions ( GKObject target = nullptr) const
pure virtual

List all possible the actions. The target parameter is deprecated.

Implemented in GKObjectKernelAction.

◆ getTaskId()

virtual QString GKKernelAction::getTaskId ( ) const
virtual

If the execute command generated a task, its id.

© Aimsun SLU
Aimsun ®