sm::Event Class Reference

Event class used in the state machine. More...

#include <Event.h>

Public Types
enum	{ EVENT_IGNORED = 0xFE }

Public Member Functions
	Event (std::string name, std::string senderInfo)
virtual	~Event ()
void	enableTransition (unsigned int from, unsigned int to)
unsigned int	getNewState (unsigned int currentState)
	Check if there is a transition to a new state. The current state is used to lookup the new state. More...
EventData *	getEventData ()
	Get event data that was possibly send with this event. If the function returns nullptr, it contains no data. More...
const char *	name () const
const char *	senderInfo () const

Protected Attributes
EventData *	_eventData = nullptr

Private Attributes
std::map< unsigned int, unsigned int >	_transitions
std::string	_name
std::string	_senderInfo

Detailed Description

Event class used in the state machine.

Definition at line 31 of file Event.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
EVENT_IGNORED

Definition at line 34 of file Event.h.

    {
        EVENT_IGNORED = 0xFE,
    };

Constructor & Destructor Documentation

Event()

sm::Event::Event ( std::string  name, std::string  senderInfo  )

inline

Definition at line 39 of file Event.h.

      : _name(name),
        _senderInfo(senderInfo)
    {
    }

~Event()

virtual sm::Event::~Event ( )

inlinevirtual

Definition at line 45 of file Event.h.

{};

Member Function Documentation

enableTransition()

void sm::Event::enableTransition ( unsigned int  from, unsigned int  to  )

inline

Definition at line 48 of file Event.h.

    {
        _transitions[from] = to;
    }

getEventData()

EventData* sm::Event::getEventData ( )

inline

Get event data that was possibly send with this event. If the function returns nullptr, it contains no data.

Returns

EventData*

Definition at line 72 of file Event.h.

    {
        return _eventData;
    }

getNewState()

unsigned int sm::Event::getNewState ( unsigned int  currentState )

inline

Check if there is a transition to a new state. The current state is used to lookup the new state.

Definition at line 54 of file Event.h.

    {
        auto it = _transitions.find(currentState);
        if (it != _transitions.end())
        {
            return it->second;
        }
        else
        {
            return EVENT_IGNORED;
        }
    }

name()

const char* sm::Event::name ( ) const

inline

Definition at line 77 of file Event.h.

{ return _name.c_str(); }

senderInfo()

const char* sm::Event::senderInfo ( ) const

inline

Definition at line 78 of file Event.h.

{ return _senderInfo.c_str(); }

Member Data Documentation

_eventData

EventData* sm::Event::_eventData = nullptr

protected

Definition at line 81 of file Event.h.

_name

std::string sm::Event::_name

private

Definition at line 86 of file Event.h.

_senderInfo

std::string sm::Event::_senderInfo

private

Definition at line 87 of file Event.h.

_transitions

std::map<unsigned int, unsigned int> sm::Event::_transitions

private

Definition at line 84 of file Event.h.

---

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

• Event.h