Event Class Reference

Abstract class for events used as StateMachine triggers to transition between states. Events must be explicitly tied to a current State and state to transition to once the event has been triggered. This is done using a Transition object in a designed StateMachine. More...

#include <Event.h>

Collaboration diagram for Event:

Public Member Functions
	Event (StateMachine *p, const char n[]=NULL)
virtual bool	check (void)=0
	Virtual check function Must be implemented for each event. The check function is called each event loop to determine if a transition has been triggered from the current state to the transition defined next state. More...
const char *	getName (void)

Public Attributes
StateMachine *	owner

Private Attributes
const char *	name

Detailed Description

Abstract class for events used as StateMachine triggers to transition between states. Events must be explicitly tied to a current State and state to transition to once the event has been triggered. This is done using a Transition object in a designed StateMachine.

Definition at line 23 of file Event.h.

Constructor & Destructor Documentation

Event::Event	(	StateMachine *	p,
		const char	n[] = NULL
	)

Definition at line 27 of file Event.h.

Member Function Documentation

virtual bool Event::check ( void  )

pure virtual

Virtual check function Must be implemented for each event. The check function is called each event loop to determine if a transition has been triggered from the current state to the transition defined next state.

const char * Event::getName

(

void

)

Definition at line 8 of file Event.cpp.

Member Data Documentation

const char* Event::name

private

Definition at line 41 of file Event.h.

StateMachine* Event::owner

Definition at line 25 of file Event.h.

---

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

• Refactor/src/libs/stateMachine/Event.h
• Refactor/src/libs/stateMachine/Event.cpp