TestDoubleOSWrapper::TestDoublePeriodicTimer Class Reference

#include <TestDoublePeriodicTimerFactory.h>

Public Member Functions
	TestDoublePeriodicTimer ()
void	setCreateArgs (OSWrapper::Runnable *r, unsigned long periodInMillis, const char *name)
virtual	~TestDoublePeriodicTimer ()
virtual void	start ()
	Start the timer.
virtual void	stop ()
	Stop the timer.
virtual bool	isStarted () const
	Return true if the timer is started.
virtual unsigned long	getPeriodInMillis () const
	Get the timer period (in milliseconds)
virtual void	setName (const char *name)
	Set the object's name.
virtual const char *	getName () const
	Get the object's name.
Public Member Functions inherited from OSWrapper::PeriodicTimer
void	setUncaughtExceptionHandler (UncaughtExceptionHandler *handler)
	Set the UncaughtExceptionHandler for this PeriodicTimer.
UncaughtExceptionHandler *	getUncaughtExceptionHandler () const
	Get the UncaughtExceptionHandler for this PeriodicTimer.

Protected Attributes
OSWrapper::Runnable *	m_runnable
unsigned long	m_periodInMillis
const char *	m_name

Additional Inherited Members
Static Public Member Functions inherited from OSWrapper::PeriodicTimer
static void	setDefaultUncaughtExceptionHandler (UncaughtExceptionHandler *handler)
	Set the default UncaughtExceptionHandler for all the PeriodicTimer.
static UncaughtExceptionHandler *	getDefaultUncaughtExceptionHandler ()
	Get the default UncaughtExceptionHandler.
static PeriodicTimer *	create (Runnable *r, unsigned long periodInMillis, const char *name="")
	Create a PeriodicTimer object.
static void	destroy (PeriodicTimer *t)
	Destroy a PeriodicTimer object.
Protected Member Functions inherited from OSWrapper::PeriodicTimer
	PeriodicTimer (Runnable *r)
virtual	~PeriodicTimer ()
void	timerMain ()
	Common timer main method.

Constructor & Destructor Documentation

TestDoublePeriodicTimer()

TestDoubleOSWrapper::TestDoublePeriodicTimer::TestDoublePeriodicTimer ( )

inline

~TestDoublePeriodicTimer()

virtual TestDoubleOSWrapper::TestDoublePeriodicTimer::~TestDoublePeriodicTimer ( )

inlinevirtual

Member Function Documentation

getName()

virtual const char * TestDoubleOSWrapper::TestDoublePeriodicTimer::getName ( ) const

inlinevirtual

Get the object's name.

Returns

The object's name

Implements OSWrapper::PeriodicTimer.

getPeriodInMillis()

virtual unsigned long TestDoubleOSWrapper::TestDoublePeriodicTimer::getPeriodInMillis ( ) const

inlinevirtual

Get the timer period (in milliseconds)

Returns

Timer period (in milliseconds)

Implements OSWrapper::PeriodicTimer.

isStarted()

virtual bool TestDoubleOSWrapper::TestDoublePeriodicTimer::isStarted ( ) const

inlinevirtual

Return true if the timer is started.

Return values

true	The timer is already started
false	The timer is already stopped

Implements OSWrapper::PeriodicTimer.

setCreateArgs()

void TestDoubleOSWrapper::TestDoublePeriodicTimer::setCreateArgs ( OSWrapper::Runnable *  r, unsigned long  periodInMillis, const char *  name  )

inline

setName()

virtual void TestDoubleOSWrapper::TestDoublePeriodicTimer::setName ( const char *  name )

inlinevirtual

Set the object's name.

Parameters

name	The object's name

Implements OSWrapper::PeriodicTimer.

start()

virtual void TestDoubleOSWrapper::TestDoublePeriodicTimer::start ( )

inlinevirtual

Start the timer.

When the timer period elapses, the timer calls Runnable::run() specified at create(). The timer calls the Runnable::run() per period.

Note

If the timer is already started, do nothing.

If the timer is stopped, you can start() again.

Implements OSWrapper::PeriodicTimer.

stop()

virtual void TestDoubleOSWrapper::TestDoublePeriodicTimer::stop ( )

inlinevirtual

Stop the timer.

Note

If the timer is already stopped, do nothing.

Implements OSWrapper::PeriodicTimer.

Member Data Documentation

m_name

const char* TestDoubleOSWrapper::TestDoublePeriodicTimer::m_name

protected

m_periodInMillis

unsigned long TestDoubleOSWrapper::TestDoublePeriodicTimer::m_periodInMillis

protected

m_runnable

OSWrapper::Runnable* TestDoubleOSWrapper::TestDoublePeriodicTimer::m_runnable

protected

---

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

• platform/TestDoubleOSWrapper/TestDoublePeriodicTimerFactory.h