TestDoubleOSWrapper::TestDoubleOneShotTimer Class Reference

#include <TestDoubleOneShotTimerFactory.h>

Public Member Functions
	TestDoubleOneShotTimer ()
void	setCreateArgs (OSWrapper::Runnable *r, const char *name)
virtual	~TestDoubleOneShotTimer ()
virtual void	start (unsigned long timeInMillis)
	Start the timer.
virtual void	stop ()
	Stop the timer.
virtual bool	isStarted () const
	Return true if the timer is started.
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::OneShotTimer
void	setUncaughtExceptionHandler (UncaughtExceptionHandler *handler)
	Set the UncaughtExceptionHandler for this OneShotTimer.
UncaughtExceptionHandler *	getUncaughtExceptionHandler () const
	Get the UncaughtExceptionHandler for this OneShotTimer.

Protected Attributes
OSWrapper::Runnable *	m_runnable
const char *	m_name

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

Constructor & Destructor Documentation

TestDoubleOneShotTimer()

TestDoubleOSWrapper::TestDoubleOneShotTimer::TestDoubleOneShotTimer ( )

inline

~TestDoubleOneShotTimer()

virtual TestDoubleOSWrapper::TestDoubleOneShotTimer::~TestDoubleOneShotTimer ( )

inlinevirtual

Member Function Documentation

getName()

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

inlinevirtual

Get the object's name.

Returns

The object's name

Implements OSWrapper::OneShotTimer.

isStarted()

virtual bool TestDoubleOSWrapper::TestDoubleOneShotTimer::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::OneShotTimer.

setCreateArgs()

void TestDoubleOSWrapper::TestDoubleOneShotTimer::setCreateArgs ( OSWrapper::Runnable *  r, const char *  name  )

inline

setName()

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

inlinevirtual

Set the object's name.

Parameters

name	The object's name

Implements OSWrapper::OneShotTimer.

start()

virtual void TestDoubleOSWrapper::TestDoubleOneShotTimer::start ( unsigned long  timeInMillis )

inlinevirtual

Start the timer.

After the timeInMillis elapses, the timer calls Runnable::run() specified at create(). When the timer is fired one time, the timer is stopped.

Parameters

timeInMillis

Time in milliseconds until the timer is fired

Note

If the timer is already started, do nothing.

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

Implements OSWrapper::OneShotTimer.

stop()

virtual void TestDoubleOSWrapper::TestDoubleOneShotTimer::stop ( )

inlinevirtual

Stop the timer.

Before the timer is fired, it stops the timer.

Note

If the timer is already stopped, do nothing.

Implements OSWrapper::OneShotTimer.

Member Data Documentation

m_name

const char* TestDoubleOSWrapper::TestDoubleOneShotTimer::m_name

protected

m_runnable

OSWrapper::Runnable* TestDoubleOSWrapper::TestDoubleOneShotTimer::m_runnable

protected

---

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

• platform/TestDoubleOSWrapper/TestDoubleOneShotTimerFactory.h