Home

QtSsmInvoker Class Reference

The QtSsmInvoker class an invoker, which the state-machine context can activate or cancel with an <invoke> tag. More...

 #include <QtSsmInvoker>

Inherits QObject.

• List of all members, including inherited members

Public Functions

• virtual ~QtSsmInvoker ()

• 29 public functions inherited from QObject

Public Slots

• virtual void activate () = 0
• virtual void cancel ()

• 1 public slot inherited from QObject

Protected Functions

• QtSsmInvoker ( QtScriptedEvent * ievent, QtStateMachine * parent )
• QtScriptedStateMachine * parentStateMachine ()
• void postParentEvent ( QtScriptedEvent * e )

• 7 protected functions inherited from QObject

Protected Slots

• void postParentEvent ( const QString & e )

Additional Inherited Members

• 1 property inherited from QObject
• 1 signal inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QObject
• 2 protected variables inherited from QObject

Detailed Description

The QtSsmInvoker class an invoker, which the state-machine context can activate or cancel with an <invoke> tag.

An invoker is a object that represents an external component that the state machine can activate when the encompassing state is entered, or cancel when the encompassing state is exited from.

Member Function Documentation

QtSsmInvoker::QtSsmInvoker ( QtScriptedEvent * ievent, QtStateMachine * parent )   [protected]

When reimplementing the constructor, always use the two parameters (ievent and parent), as they're called from QtSsmInvokerFactory.

QtSsmInvoker::~QtSsmInvoker ()   [virtual]

void QtSsmInvoker::activate ()   [pure virtual slot]

This function is called when the encompassing state is entered. The call to this function from the state-machine context is asynchronous, to make sure that the state is not exited during the same step in which it's entered.

void QtSsmInvoker::cancel ()   [virtual slot]

Reimplement this function to allow for asynchronous cancellation of the invoker. It's the invoker's responsibility to delete itself after this function has been called. The default implementation deletes the invoker.

QtScriptedStateMachine * QtSsmInvoker::parentStateMachine ()   [protected]

Returns the state machine encompassing the invoker.

void QtSsmInvoker::postParentEvent ( QtScriptedEvent * e )   [protected]

Posts an event e to the state machine encompassing the invoker.

void QtSsmInvoker::postParentEvent ( const QString & e )   [protected slot]

This is an overloaded member function, provided for convenience.

Posts a QtScriptedEvent named e to the encompassing state machine.