CVD::EventObject Class Reference

Encapsulation of a condition variable and its boolean condition. More...

#include <eventobject.h>

Inheritance diagram for CVD::EventObject:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 EventObject ()
 Construct an initially untriggered event.
void trigger ()
 Set the condition boolean to true and wake up one thread waiting on the event.
void triggerAll ()
 Set the condition boolean to true and wake up all threads waiting on the event.
bool wait (unsigned int milli)
 Block until the condition is true or the specified timeout has elapsed. Reset the condition before returning if the condition became true.
void wait ()
 Block until the condition is true. Reset the condition before returning.
virtual ~EventObject ()

Protected Attributes

pthread_cond_t myCondVar

Detailed Description

Encapsulation of a condition variable and its boolean condition.

Definition at line 8 of file eventobject.h.


Constructor & Destructor Documentation

CVD::EventObject::EventObject (  ) 

Construct an initially untriggered event.

virtual CVD::EventObject::~EventObject (  )  [virtual]

Member Function Documentation

void CVD::EventObject::trigger (  ) 

Set the condition boolean to true and wake up one thread waiting on the event.

void CVD::EventObject::triggerAll (  ) 

Set the condition boolean to true and wake up all threads waiting on the event.

bool CVD::EventObject::wait ( unsigned int  milli  ) 

Block until the condition is true or the specified timeout has elapsed. Reset the condition before returning if the condition became true.

void CVD::EventObject::wait (  ) 

Block until the condition is true. Reset the condition before returning.


Member Data Documentation

pthread_cond_t CVD::EventObject::myCondVar [protected]

Definition at line 21 of file eventobject.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


libcvd
Author(s): Edward Rosten, Paul Smith, Tom Drummond, Gerhard Reitmayr, Ethan Eade, Timothy Gan, Chris Kemp, Georg Klein
autogenerated on Fri Jan 11 09:13:51 2013