TRC Library for FRC (2011) 2011
TRC Library Code Project

Event Class Reference

#include <Event.h>

List of all members.

Public Member Functions

 Event (void)
 ~Event (void)
void SetEvent (void)
void ClearEvent (void)
bool IsSignaled (void)

Detailed Description

This class defines the event object. An event object is used with a state machine. After the state machine has initiated an operation, it usaully waits for the operation to complete before moves onto the next state. The event object is used for this purpose. When an event occurred, a notify object is usually called. In the notify object, the event object is signaled. The state machine periodically checks with the events it is waiting on. If the events it is waiting on are signaled, it will advance the state machine to the next state.

Definition at line 38 of file Event.h.


Constructor & Destructor Documentation

Event::Event ( void  ) [inline]

Constructor: Create an instance of the Event object.

Definition at line 47 of file Event.h.

Event::~Event ( void  ) [inline]

Destructor: Destroy an instance of the Event object.

Definition at line 59 of file Event.h.


Member Function Documentation

void Event::ClearEvent ( void  ) [inline]

This function is called to clear the event.

Definition at line 86 of file Event.h.

bool Event::IsSignaled ( void  ) [inline]

This function is called to check if the event is in signaled state.

Returns:
Returns true if the event is in signaled state, false otherwise.

Definition at line 103 of file Event.h.

void Event::SetEvent ( void  ) [inline]

This function is called to set the event to signaled state.

Definition at line 72 of file Event.h.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Defines