Main MRPT website > C++ reference
MRPT logo
List of all members | Public Member Functions | Private Attributes
mrpt::synch::CEvent Class Reference

Detailed Description

This class provides a simple way of waiting for and signaling events (NOT IMPLEMENTED YET!).

Definition at line 45 of file CEvent.h.

#include <mrpt/synch/CEvent.h>

Public Member Functions

 CEvent (bool initialSignaled)
 Constructor: set the initial signaled state of the event.
 
 ~CEvent ()
 Destructor.
 
void signal ()
 Signal the event: the first waiting thread resumes execution (if no thread is waiting, the object keeps signaled)
 
void wait ()
 Waits for the event to be signaled.
 
void reset ()
 Manual reset of the event, without waiting to a signaled state (without effect if it is currently not signaled)
 

Private Attributes

utils::CReferencedMemBlock m_data
 

Constructor & Destructor Documentation

mrpt::synch::CEvent::CEvent ( bool  initialSignaled)

Constructor: set the initial signaled state of the event.

mrpt::synch::CEvent::~CEvent ( )

Destructor.

Member Function Documentation

void mrpt::synch::CEvent::reset ( )

Manual reset of the event, without waiting to a signaled state (without effect if it is currently not signaled)

void mrpt::synch::CEvent::signal ( )

Signal the event: the first waiting thread resumes execution (if no thread is waiting, the object keeps signaled)

void mrpt::synch::CEvent::wait ( )

Waits for the event to be signaled.

Member Data Documentation

utils::CReferencedMemBlock mrpt::synch::CEvent::m_data
private

Definition at line 48 of file CEvent.h.




Page generated by Doxygen 1.8.3 for MRPT 0.9.6 SVN: at Fri Feb 15 22:05:02 EST 2013