OSWrapper::PeriodicTimer Class Reference

Abstract class that has functions of common RTOS's periodic timer. More...

#include <PeriodicTimer.h>

Classes
class	UncaughtExceptionHandler
	Interface for handling uncaught exception. More...

Public Member Functions
virtual void	start ()=0
	Start the timer.
virtual void	stop ()=0
	Stop the timer.
virtual bool	isStarted () const =0
	Return true if the timer is started.
virtual unsigned long	getPeriodInMillis () const =0
	Get the timer period (in milliseconds)
virtual void	setName (const char *name)=0
	Set the object's name.
virtual const char *	getName () const =0
	Get the object's name.
void	setUncaughtExceptionHandler (UncaughtExceptionHandler *handler)
	Set the UncaughtExceptionHandler for this PeriodicTimer.
UncaughtExceptionHandler *	getUncaughtExceptionHandler () const
	Get the UncaughtExceptionHandler for this PeriodicTimer.

Static Public Member Functions
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
	PeriodicTimer (Runnable *r)
virtual	~PeriodicTimer ()
void	timerMain ()
	Common timer main method.

Detailed Description

Abstract class that has functions of common RTOS's periodic timer.

Constructor & Destructor Documentation

PeriodicTimer()

OSWrapper::PeriodicTimer::PeriodicTimer ( Runnable *  r )

inlineexplicitprotected

~PeriodicTimer()

virtual OSWrapper::PeriodicTimer::~PeriodicTimer ( )

inlineprotectedvirtual

Member Function Documentation

create()

PeriodicTimer * OSWrapper::PeriodicTimer::create ( Runnable *  r, unsigned long  periodInMillis, const char *  name = ""  )

static

Create a PeriodicTimer object.

Parameters

r	Pointer of Runnable object
periodInMillis	Timer period in milliseconds
name	Name of the object

Returns

If this method succeeds then returns a pointer of PeriodicTimer object, else returns null pointer

Note

Created PeriodicTimer object is stopped. You need to call start() for the PeriodicTimer object.

destroy()

void OSWrapper::PeriodicTimer::destroy ( PeriodicTimer *  t )

static

Destroy a PeriodicTimer object.

Parameters

t	Pointer of PeriodicTimer object created by PeriodicTimer::create()

Note

If t is null pointer, do nothing.

getDefaultUncaughtExceptionHandler()

PeriodicTimer::UncaughtExceptionHandler * OSWrapper::PeriodicTimer::getDefaultUncaughtExceptionHandler ( )

static

Get the default UncaughtExceptionHandler.

Returns

The default UncaughtExceptionHandler object

getName()

virtual const char * OSWrapper::PeriodicTimer::getName ( ) const

pure virtual

Get the object's name.

Returns

The object's name

Implemented in StdCppOSWrapper::StdCppPeriodicTimer, TestDoubleOSWrapper::TestDoublePeriodicTimer, and WindowsOSWrapper::WindowsPeriodicTimer.

getPeriodInMillis()

virtual unsigned long OSWrapper::PeriodicTimer::getPeriodInMillis ( ) const

pure virtual

Get the timer period (in milliseconds)

Returns

Timer period (in milliseconds)

Implemented in StdCppOSWrapper::StdCppPeriodicTimer, TestDoubleOSWrapper::TestDoublePeriodicTimer, and WindowsOSWrapper::WindowsPeriodicTimer.

getUncaughtExceptionHandler()

PeriodicTimer::UncaughtExceptionHandler * OSWrapper::PeriodicTimer::getUncaughtExceptionHandler

(

)

const

Get the UncaughtExceptionHandler for this PeriodicTimer.

Returns

The UncaughtExceptionHandler object

isStarted()

virtual bool OSWrapper::PeriodicTimer::isStarted ( ) const

pure virtual

Return true if the timer is started.

Return values

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

Implemented in StdCppOSWrapper::StdCppPeriodicTimer, TestDoubleOSWrapper::TestDoublePeriodicTimer, and WindowsOSWrapper::WindowsPeriodicTimer.

setDefaultUncaughtExceptionHandler()

void OSWrapper::PeriodicTimer::setDefaultUncaughtExceptionHandler ( PeriodicTimer::UncaughtExceptionHandler *  handler )

static

Set the default UncaughtExceptionHandler for all the PeriodicTimer.

Parameters

handler

Pointer of UncaughtExceptionHandler object

setName()

virtual void OSWrapper::PeriodicTimer::setName ( const char *  name )

pure virtual

Set the object's name.

Parameters

name	The object's name

Implemented in StdCppOSWrapper::StdCppPeriodicTimer, TestDoubleOSWrapper::TestDoublePeriodicTimer, and WindowsOSWrapper::WindowsPeriodicTimer.

setUncaughtExceptionHandler()

void OSWrapper::PeriodicTimer::setUncaughtExceptionHandler

(

PeriodicTimer::UncaughtExceptionHandler *

handler

)

Set the UncaughtExceptionHandler for this PeriodicTimer.

Parameters

handler

Pointer of UncaughtExceptionHandler object

Note

If set UncaughtExceptionHandler by this method then the default UncaughtExceptionHandler is not called when an exception is not caught.

start()

virtual void OSWrapper::PeriodicTimer::start ( )

pure virtual

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.

Implemented in StdCppOSWrapper::StdCppPeriodicTimer, TestDoubleOSWrapper::TestDoublePeriodicTimer, and WindowsOSWrapper::WindowsPeriodicTimer.

stop()

virtual void OSWrapper::PeriodicTimer::stop ( )

pure virtual

Stop the timer.

Note

If the timer is already stopped, do nothing.

Implemented in StdCppOSWrapper::StdCppPeriodicTimer, TestDoubleOSWrapper::TestDoublePeriodicTimer, and WindowsOSWrapper::WindowsPeriodicTimer.

timerMain()

void OSWrapper::PeriodicTimer::timerMain ( )

protected

Common timer main method.

Note

Called in the concrete class derived from PeriodicTimer.

---

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

• mechanism/OSWrapper/PeriodicTimer.h
• mechanism/OSWrapper/PeriodicTimer.cpp