mrpt::synch::CEvent Class Reference

This class provides a simple way of waiting for and signaling events. More...

#include <mrpt/synch/CEvent.h>

List of all members.

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

---

Detailed Description

This class provides a simple way of waiting for and signaling events.

Definition at line 46 of file CEvent.h.

---

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 49 of file CEvent.h.