mds::sys::CTimer Class Reference

Class encapsulating timer functions. More...

#include <mdsTimer.h>

Inheritance diagram for mds::sys::CTimer:

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
	CTimer (unsigned uDelay, bool bRun=true)
	Constructor.
unsigned	getDelay ()
	Returns the timer delay.
int	getReferencesCount () const
	Returns the number of references.
bool	isOnHeap () const
	Returns true if the object is allocated on the heap.
bool	isRunning ()
	Returns true if the timer is already running.
	MDS_SHAREDPTR (CTimer)
	Smart pointer type.
void	setDelay (unsigned uDelay)
	Sets the timer delay.
void	signal ()
	Signals the timer event.
void	start ()
	Starts the timer.
void	stop ()
	Stops the timer.
bool	wait (unsigned uTimeout)
	Waits for the timer event.
virtual	~CTimer ()
	Default 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
CEvent	m_Event
	Event signalled every time the timer delay elapses.
int	m_iHeapObject
	Flag initialized if the object is on the heap.
int	m_iReferences
	The number of references to the object.
unsigned	m_uDelay
	The timer delay.

---

Detailed Description

Class encapsulating timer functions.

---

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::CTimer::CTimer	(	unsigned	uDelay,
		bool	bRun = true
	)

Constructor.

virtual mds::sys::CTimer::~CTimer

(

)

[virtual]

Default 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.

unsigned mds::sys::CTimer::getDelay

(

)

Returns the timer delay.

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::CTimer::isRunning

(

)

Returns true if the timer is already running.

mds::sys::CTimer::MDS_SHAREDPTR

(

CTimer

)

Smart pointer type.

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

(

std::size_t

Size

)

[static, inherited]

Allocates a new object on the heap.

void mds::sys::CTimer::setDelay

(

unsigned

uDelay

)

Sets the timer delay.

void mds::sys::CTimer::signal

(

)

Signals the timer event.

void mds::sys::CTimer::start

(

)

Starts the timer.

void mds::sys::CTimer::stop

(

)

Stops the timer.

bool mds::sys::CTimer::wait

(

unsigned

uTimeout

)

Waits for the timer event.

---

Member Data Documentation

CEvent mds::sys::CTimer::m_Event [protected]

Event signalled every time the timer delay elapses.

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.

unsigned mds::sys::CTimer::m_uDelay [protected]

The timer delay.

---

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

• mdsTimer.h