mds::sys::CEvent Class Reference

Class encapsulating system event. More...

#include <mdsEvent.h>

Inheritance diagram for mds::sys::CEvent:

List of all members.

Public Types
enum	{ CLASS_OBJECT }
	Templates that require members of the CObject class can use this enum to check the existence. More...
enum	{ HEAP_OBJECT = 0x70616568 }
	Signature used to recognize objects on the heap. More...
Public Member Functions
	CEvent (bool bState=false, bool bManual=false)
	Constructor.
int	getReferencesCount () const
	Returns the number of references.
bool	isOnHeap () const
	Returns true if the object is allocated on the heap.
bool	isSet ()
	True if event is in signaled state.
	MDS_SHAREDPTR (CEvent)
	Smart pointer type.
bool	reset ()
	Resets the event to non-signaled state.
bool	set ()
	Sets the event to signaled state.
bool	wait (unsigned uTimeout=MDS_WAIT_INFINITE)
	Wait for the event's signaled state.
virtual	~CEvent ()
	Standard destructor.
Static Public Member Functions
static void *	operator new (std::size_t Size)
	Allocates a new object on the heap.
Protected Member Functions
void	addReference () const
	Increase the reference counter.
bool	delReference () const
	Decrease the reference counter.
Protected Attributes
bool	m_bManual
	Type of the event.
int	m_iHeapObject
	Flag initialized if the object is on the heap.
int	m_iReferences
	The number of references to the object.

---

Detailed Description

Class encapsulating system event.

---

Member Enumeration Documentation

anonymous enum [inherited]

Templates that require members of the CObject class can use this enum to check the existence.

Enumerator:

CLASS_OBJECT

anonymous enum [inherited]

Signature used to recognize objects on the heap.

Enumerator:

HEAP_OBJECT

---

Constructor & Destructor Documentation

mds::sys::CEvent::CEvent	(	bool	bState = false,
		bool	bManual = false
	)

Constructor.

• Creates a new event.

virtual mds::sys::CEvent::~CEvent

(

)

[virtual]

Standard destructor.

---

Member Function Documentation

void mds::base::CObject::addReference

(

)

const [protected, inherited]

Increase the reference counter.

bool mds::base::CObject::delReference

(

)

const [protected, inherited]

Decrease the reference counter.

• Returns true if the decremented number of references is lower or equal to zero and object must be deleted.

int mds::base::CObject::getReferencesCount

(

)

const [inherited]

Returns the number of references.

bool mds::base::CObject::isOnHeap

(

)

const [inherited]

Returns true if the object is allocated on the heap.

bool mds::sys::CEvent::isSet

(

)

True if event is in signaled state.

mds::sys::CEvent::MDS_SHAREDPTR

(

CEvent

)

Smart pointer type.

static void* mds::base::CObject::operator new

(

std::size_t

Size

)

[static, inherited]

Allocates a new object on the heap.

bool mds::sys::CEvent::reset

(

)

Resets the event to non-signaled state.

bool mds::sys::CEvent::set

(

)

Sets the event to signaled state.

• Returns true on success.

bool mds::sys::CEvent::wait

(

unsigned

uTimeout = MDS_WAIT_INFINITE

)

Wait for the event's signaled state.

---

Member Data Documentation

bool mds::sys::CEvent::m_bManual [protected]

Type of the event.

• If the type is manual reseted then all waiting threads are released.
• Otherwise just one waiting thread wakes up.

int mds::base::CObject::m_iHeapObject [mutable, protected, inherited]

Flag initialized if the object is on the heap.

int mds::base::CObject::m_iReferences [mutable, protected, inherited]

The number of references to the object.

• Zero if there is no reference.

---

The documentation for this class was generated from the following file:

• mdsEvent.h