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

TrcTimer Class Reference

#include <TrcTimer.h>

List of all members.

Public Member Functions

 TrcTimer (void)
 ~TrcTimer (void)
bool SetTimer (__in double delay, __in TimerNotify *notify, __in void *context=NULL)
void CancelTimer (void)

Detailed Description

This class defines the timer object. It allows the caller to set a timer and notifies the caller when the timer expires.

Definition at line 54 of file TrcTimer.h.

Constructor & Destructor Documentation

TrcTimer::TrcTimer ( void  ) [inline]

Constructor: Create an instance of the TrcTimer object.

Definition at line 109 of file TrcTimer.h.

TrcTimer::~TrcTimer ( void  ) [inline]

Destructor: Destroy an instance of the TrcTimer object.

Definition at line 126 of file TrcTimer.h.

Member Function Documentation

void TrcTimer::CancelTimer ( void  ) [inline]

This function cancels a pending timer.

Definition at line 183 of file TrcTimer.h.

bool TrcTimer::SetTimer ( __in double  delay,
__in TimerNotify notify,
__in void *  context = NULL 
) [inline]

This function sets a timer to be expired with a given delay.

delaySpecifies the amount of time in seconds the timer will expire.
notifyPoints to the TimerNotify object for the callback.
contextSpecifies the context to be passed back on the callback.
Returns true if success, false otherwise.

Definition at line 149 of file TrcTimer.h.

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