NuguClientKit::INuguTimer Class Reference

nugu timer interface More...

#include <nugu_timer_interface.hh>

Public Types
typedef std::function< void()>	timer_callback
	Timer Callback.

Public Member Functions
virtual unsigned int	getInterval ()=0
	Get timer's timeout interval. More...
virtual bool	getSingleShot ()=0
	Get timer single shot property. More...
virtual void	restart (unsigned int msec=0)=0
	Request re-start timer with new interval. More...
virtual void	setCallback (timer_callback cb)=0
	Request set timeout callback. More...
virtual void	setInterval (unsigned int msec)=0
	Set timer's timeout interval. More...
virtual void	setSingleShot (bool singleShot)=0
	Set timer running single shot. More...
virtual void	start (unsigned int msec=0)=0
	Request start timer with new interval. More...
virtual void	stop ()=0
	Request stop timer.

Detailed Description

nugu timer interface

Member Function Documentation

setInterval()

virtual void NuguClientKit::INuguTimer::setInterval ( unsigned int  msec )

pure virtual

Set timer's timeout interval.

Parameters

[in]

msec

timeout (unit: msec)

getInterval()

virtual unsigned int NuguClientKit::INuguTimer::getInterval ( )

pure virtual

Get timer's timeout interval.

Returns

timeout interval (unit: msec)

setSingleShot()

virtual void NuguClientKit::INuguTimer::setSingleShot ( bool  singleShot )

pure virtual

Set timer running single shot.

Parameters

[in]

singleshot

singleshot

getSingleShot()

virtual bool NuguClientKit::INuguTimer::getSingleShot ( )

pure virtual

Get timer single shot property.

Returns

single shot value

start()

virtual void NuguClientKit::INuguTimer::start ( unsigned int  msec = 0 )

pure virtual

Request start timer with new interval.

Parameters

[in]

msec

timeout interval. The timer works with internal interval if msec is 0.

restart()

virtual void NuguClientKit::INuguTimer::restart ( unsigned int  msec = 0 )

pure virtual

Request re-start timer with new interval.

Parameters

[in]

msec

timeout interval. The timer works with internal interval if msec is 0.

setCallback()

virtual void NuguClientKit::INuguTimer::setCallback ( timer_callback  cb )

pure virtual

Request set timeout callback.

Parameters

[in]

cb

timeout callback

---

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

• nugu_timer_interface.hh