WPILib 2012
WPILibRoboticsLibraryforFRC
Public Member Functions
Notifier Class Reference
Inheritance diagram for Notifier:
ErrorBase

List of all members.

Public Member Functions

 Notifier (TimerEventHandler handler, void *param=NULL)
virtual ~Notifier ()
void StartSingle (double delay)
void StartPeriodic (double period)
void Stop ()

Constructor & Destructor Documentation

Notifier::Notifier ( TimerEventHandler  handler,
void *  param = NULL 
)

Create a Notifier for timer event notification.

Parameters:
handlerThe handler is called at the notification time which is set using StartSingle or StartPeriodic.
Notifier::~Notifier ( ) [virtual]

Free the resources for a timer event. All resources will be freed and the timer event will be removed from the queue if necessary.


Member Function Documentation

void Notifier::StartPeriodic ( double  period)

Register for periodic event notification. A timer event is queued for periodic event notification. Each time the interrupt occurs, the event will be immedeatly requeued for the same time interval.

Parameters:
periodPeriod in seconds to call the handler starting one period after the call to this method.
void Notifier::StartSingle ( double  delay)

Register for single event notification. A timer event is queued for a single event after the specified delay.

Parameters:
delaySeconds to wait before the handler is called.
void Notifier::Stop ( )

Stop timer events from occuring. Stop any repeating timer events from occuring. This will also remove any single notification events from the queue. If a timer-based call to the registered handler is in progress, this function will block until the handler call is complete.


The documentation for this class was generated from the following files:
 All Classes Functions Variables