Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

TimerNode Class Reference

TimerNode is an event in the Timer class queue. More...

#include <TimerNode.h>

Inheritance diagram for TimerNode::

BasicObject List of all members.

Public Methods

 TimerNode (void *(*func)(void *), void *data, TimeValue wakeup, bool *set)
 Create an event. More...

virtual ~TimerNode ()
bool past ()
 Return true if the event should have fired already. More...

void * getArg ()
 Return the argument that will be passed to the function. More...

bool isValid ()
 Return true if this event is still valid. More...

void *(* getFunc ())(void *)
TimeValue getWakeup ()
 Return the wakeup time of this event. More...

virtual void toStream (std::ostream &)
 Print out wake up time and isValid. More...


Private Attributes

void *(* m_func )(void *)
void * m_arg
TimeValue m_wakeup
bool * m_isValid

Friends

bool operator< (const TimerNode &node1, const TimerNode &node2)
 Compare two TimerNodes. More...


Detailed Description

TimerNode is an event in the Timer class queue.

Definition at line 12 of file TimerNode.h.


Constructor & Destructor Documentation

TimerNode::TimerNode void *(* func)(void *),
void * arg,
TimeValue wakeup,
bool * set
 

Create an event.

Parameters:
func   The function to call when this event is fired.
arg   The argument to pass to the function.
wakeup   The time to wake up and execute the function.
set   A pointer to a bool. This is a way to cancel the event. If you would like to cancel the event, set the bool to false.

Definition at line 11 of file TimerNode.cpp.

virtual TimerNode::~TimerNode [inline, virtual]
 

Definition at line 16 of file TimerNode.h.


Member Function Documentation

void * TimerNode::getArg
 

Return the argument that will be passed to the function.

Definition at line 47 of file TimerNode.cpp.

Referenced by ThreadSpawningTimer::doAction(), and CallbackTimer::doAction().

void* (* TimerNode::getFunc
 

Referenced by ThreadSpawningTimer::doAction(), and CallbackTimer::doAction().

TimeValue TimerNode::getWakeup
 

Return the wakeup time of this event.

Definition at line 64 of file TimerNode.cpp.

bool TimerNode::isValid
 

Return true if this event is still valid.

Definition at line 72 of file TimerNode.cpp.

bool TimerNode::past
 

Return true if the event should have fired already.

Return false if the event hasnt happened yet.

Definition at line 34 of file TimerNode.cpp.

void TimerNode::toStream std::ostream & out [virtual]
 

Print out wake up time and isValid.

Reimplemented from BasicObject.

Definition at line 23 of file TimerNode.cpp.


Friends And Related Function Documentation

bool operator< const TimerNode & node1,
const TimerNode & node2
[friend]
 

Compare two TimerNodes.

Definition at line 80 of file TimerNode.cpp.


Member Data Documentation

void* TimerNode::m_arg [private]
 

Definition at line 28 of file TimerNode.h.

void* (* TimerNode::m_func)(void *) [private]
 

bool* TimerNode::m_isValid [private]
 

Definition at line 30 of file TimerNode.h.

TimeValue TimerNode::m_wakeup [private]
 

Definition at line 29 of file TimerNode.h.


The documentation for this class was generated from the following files:
Generated at Thu Jul 11 13:31:59 2002 for Peekabooty by doxygen1.2.9 written by Dimitri van Heesch, © 1997-2001