Event Class Reference
[State Machine Utilities]

#include <StateMachine.hh>

List of all members.

---

Detailed Description

Abstract base class for all state machine events.

This class provides a template for all event objects to be defined within state machine subclasses. Derived classes must provide an implementation for the check method to define the semantics of an event.

Public Member Functions
	Event (StateMachine *p, const char n[]=NULL)
virtual bool	check (void)=0
const char *	getName (void)
Public Attributes
StateMachine *	owner

---

Constructor & Destructor Documentation

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

This constructor creates an event object instance belonging to the state machine p, with an optional name for debugging purposes.

---

Member Function Documentation

virtual bool Event::check (  void   )  [pure virtual]

Derived implementations of this method are expected to encode the semantics of an event by returning its current boolean state.

const char* Event::getName (  void   )  [inline]

This method returns the name of a state, mainly used for debugging and display purposes.

---

Member Data Documentation

StateMachine* Event::owner

This member is an internal pointer to the owner state machine. Event methods (check in particular) can access state machine members and methods through this member.

---

RHexLib Reference Documentation