imt::base::os::winec7::TimeoutIfc Class Reference

Timeout interface. More...

#include <Imt.Base.OS.WinEC7/TimeoutIfc.h>

Public Member Functions
virtual void	setTimeout (const TimePeriod &timePeriod)=0
	Sets a timeout. More...
virtual bool	isStarted (void) const =0
	Is timer active (timeout set!). More...
virtual void	start (void)=0
	Starts the timer. More...
virtual void	stopAndReset (void)=0
	Stops and Resets the timer. More...
virtual bool	isTimeout (void) const =0
	Returns true if specified timeout is reached. More...
virtual TimePeriod	getRemainingTime (void) const =0
	Returns remaining time until timeout will be reached. More...

Protected Member Functions
	TimeoutIfc (void)
	Constructor. More...
virtual	~TimeoutIfc (void)
	Destructor. More...

Detailed Description

Timeout interface.

Should be implemented with system specific timing possiblitities.

Constructor & Destructor Documentation

TimeoutIfc()

imt::base::os::winec7::TimeoutIfc::TimeoutIfc ( void  )

inlineexplicitprotected

Constructor.

~TimeoutIfc()

virtual imt::base::os::winec7::TimeoutIfc::~TimeoutIfc ( void  )

inlineprotectedvirtual

Destructor.

Member Function Documentation

getRemainingTime()

virtual TimePeriod imt::base::os::winec7::TimeoutIfc::getRemainingTime ( void  ) const

pure virtual

Returns remaining time until timeout will be reached.

Returns

Remaining time until timeout will be reached.

isStarted()

virtual bool imt::base::os::winec7::TimeoutIfc::isStarted ( void  ) const

pure virtual

Is timer active (timeout set!).

isTimeout()

virtual bool imt::base::os::winec7::TimeoutIfc::isTimeout ( void  ) const

pure virtual

Returns true if specified timeout is reached.

Returns

True if timeout reached.

setTimeout()

virtual void imt::base::os::winec7::TimeoutIfc::setTimeout ( const TimePeriod &  timePeriod )

pure virtual

Sets a timeout.

If timeout reached, timeout() returns true.

Parameters

timePeriod

Timeout in ticks to set.

start()

virtual void imt::base::os::winec7::TimeoutIfc::start ( void  )

pure virtual

Starts the timer.

stopAndReset()

virtual void imt::base::os::winec7::TimeoutIfc::stopAndReset ( void  )

pure virtual

Stops and Resets the timer.

---

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

• D:/_Work/10/s/Imt.Base/Imt.Base.OS.WinEC7/TimeoutIfc.h