rad::GuardCallback Class Reference

#include <guardCallback.hpp>

Inheritance diagram for rad::GuardCallback:

Public Member Functions
	GuardCallback (const std::string id, std::function< bool(scxml4cpp::Context *c)> guard_method)
void	execute (scxml4cpp::Context *c) override
bool	evaluate (scxml4cpp::Context *c) override
	GuardCallback (GuardCallback &&)=default
GuardCallback &	operator= (GuardCallback &&)=default
	GuardCallback (const GuardCallback &)=delete
GuardCallback &	operator= (const GuardCallback &)=delete
	Disable copy constructor. More...
	GuardCallback (const std::string id, std::function< bool(scxml4cpp::Context *c)> guard_method)
void	execute (scxml4cpp::Context *c) override
bool	evaluate (scxml4cpp::Context *c) override
	GuardCallback (GuardCallback &&)=default
GuardCallback &	operator= (GuardCallback &&)=default
	GuardCallback (const GuardCallback &)=delete
GuardCallback &	operator= (const GuardCallback &)=delete
	Disable copy constructor. More...
Public Member Functions inherited from scxml4cpp::Action
	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)
	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)
	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)

Detailed Description

This class binds an scxml::Guard to a method of a class.

Constructor & Destructor Documentation

GuardCallback() [1/6]

rad::GuardCallback::GuardCallback ( const std::string  id, std::function< bool(scxml4cpp::Context *c)>  guard_method  )

explicit

Parameters

[in]	id	Guard name.
[in]	guard_method	Mapping to the class method implementing the guard.

GuardCallback() [2/6]

rad::GuardCallback::GuardCallback ( GuardCallback &&  )

default

GuardCallback() [3/6]

rad::GuardCallback::GuardCallback ( const GuardCallback &  )

delete

GuardCallback() [4/6]

rad::GuardCallback::GuardCallback ( const std::string  id, std::function< bool(scxml4cpp::Context *c)>  guard_method  )

explicit

GuardCallback() [5/6]

rad::GuardCallback::GuardCallback ( GuardCallback &&  )

default

GuardCallback() [6/6]

rad::GuardCallback::GuardCallback ( const GuardCallback &  )

delete

Member Function Documentation

evaluate() [1/2]

bool rad::GuardCallback::evaluate ( scxml4cpp::Context *  c )

overridevirtual

This method is used for the evaluation of a guard.

Implements scxml4cpp::Action.

evaluate() [2/2]

bool rad::GuardCallback::evaluate ( scxml4cpp::Context *  c )

overridevirtual

Implements scxml4cpp::Action.

execute() [1/2]

void rad::GuardCallback::execute ( scxml4cpp::Context *  c )

overridevirtual

This method is executed when an guard, mapped to a method of class is invoked. After extracting from the SCXML context the last event, it triggers the call of the class method associated to the guard.

Parameters

[in]

c

SCXML context.

Implements scxml4cpp::Action.

execute() [2/2]

void rad::GuardCallback::execute ( scxml4cpp::Context *  c )

overridevirtual

Implements scxml4cpp::Action.

operator=() [1/4]

GuardCallback& rad::GuardCallback::operator= ( const GuardCallback &  )

delete

Disable copy constructor.

operator=() [2/4]

GuardCallback& rad::GuardCallback::operator= ( const GuardCallback &  )

delete

Disable copy constructor.

operator=() [3/4]

GuardCallback& rad::GuardCallback::operator= ( GuardCallback &&  )

default

operator=() [4/4]

GuardCallback& rad::GuardCallback::operator= ( GuardCallback &&  )

default

---

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

• INTROOT/include/rad/guardCallback.hpp
• rad/cpp/sm/src/guardCallback.cpp