scxml4cpp::Action Class Reference

#include <Action.h>

Inheritance diagram for scxml4cpp::Action:

Public Member Functions
	Action (const std::string &id)
virtual	~Action ()
std::string	getId () const
std::string	getParam () const
void	setId (const std::string &id)
void	setParam (const std::string &p)
virtual void	execute (Context *c)=0
virtual bool	evaluate (Context *c)=0

Detailed Description

This class represents an interface for an Action.

An action is a piece of code executed by the State Machine interpreter. Since the execution is synchronous, it is blocking the interpretation of the SCXML document.

The implementation of the action can be added by sub-classing and implementing the execute() virtual method.

This class can also be used to implement a guard by sub-classing and implementing the evaluate() virtual method.

Actions can be executed when entering, exiting, or transitioning to a state.

Guards are evaluated before taking a transition.

Constructor & Destructor Documentation

Action()

Action::Action

(

const std::string &

id

)

Create a generic action object.

Parameters

id	Identifier of the action.

~Action()

Action::~Action ( )

virtual

Member Function Documentation

evaluate()

virtual bool scxml4cpp::Action::evaluate ( Context *  c )

pure virtual

Evaluate a guard condition usually verified before taking a transition. The evaluation is blocking the State Machine interpreter and therefore should be short (ideally it should last 0 time).

Parameters

c	Context for the execution of the action.

Returns

true If the guard is satisfied, false otherwise.

Implemented in rad::GuardCallback, TestWarningsAction, TestReplaceAction, TestDOMSCXMLReaderAction, TestAppendAction, TestCondition, TestAction, TestCondition, TestMergerAction, TestHelperAction, TestExecutorAction, TestExecutableContentAction2, TestExecutableContentAction, MyAction, TrsHealthAction, TimerAction, ReplyAction, ReplyAction, TestDummyAction, SignalAction, MyAction, rad::ActionCallback, and scxml4cpp::ActionTrace.

execute()

virtual void scxml4cpp::Action::execute ( Context *  c )

pure virtual

Execute the task associated to the action. The execution is blocking the State Machine interpreter and therefore should be short (ideally it should last 0 time).

Parameters

c	Context for the execution of the action.

Implemented in rad::GuardCallback, TestWarningsAction, TestReplaceAction, TestDOMSCXMLReaderAction, TestAppendAction, TestCondition, TestAction, TestCondition, TestMergerAction, TestHelperAction, TestExecutorAction, TestExecutableContentAction2, TestExecutableContentAction, MyAction, TrsHealthAction, TimerAction, ReplyAction, ReplyAction, TestDummyAction, SignalAction, MyAction, rad::ActionCallback, and scxml4cpp::ActionTrace.

getId()

std::string Action::getId

(

)

const

Returns

The action identifier.

getParam()

std::string Action::getParam

(

)

const

Returns

The action/guard parameters in string format.

setId()

void Action::setId

(

const std::string &

id

)

Set the action identifier.

Parameters

id	The action identifier.

setParam()

void Action::setParam

(

const std::string &

p

)

Set the action parameters.

Parameters

p	The action parameters in string format.

---

The documentation for this class was generated from the following files:

• scxml4cpp/engine/src/include/scxml4cpp/Action.h
• scxml4cpp/engine/src/Action.cpp