Contents
Inheritance:
Constructors:
Methods:
createSoftTimer (version 1)
int createSoftTimer(unsigned long int intervall,bool imm,void(*timer_callback)(AbsMsgItem *msg),AbsMsgItem *msg)
Constructors
SoftTimerManager (version 1)
This creates a new
SoftTimerManager.
Constructor:
SoftTimerManager(unsigned long int base_intervall)
Factory Method:
AbsSoftTimerManager *AbsSoftTimerManagerInterface::createSoftTimerManager(unsigned long int base_intervall)
Wrapper Class:
SoftTimerManagerWrapper(unsigned long int base_intervall)
The static method
AbsSoftTimerManagerInterface::createSoftTimerManager creates a new instance of class SoftTimerManager.
Parameters:
| unsigned long int | base_intervall | | |
Return value:Returns an instance of
SoftTimerManager.
SoftTimerManager (version 2)
This creates a new
SoftTimerManager.
This constructor uses a
ThreadMan object to manage the timer thread.
Constructor:
SoftTimerManager(unsigned long int base_intervall,AbsThreadMan *thrman)
Factory Method:
AbsSoftTimerManager *AbsSoftTimerManagerInterface::createSoftTimerManager(unsigned long int base_intervall,AbsThreadMan *thrman)
Wrapper Class:
SoftTimerManagerWrapper(unsigned long int base_intervall,AbsThreadMan *thrman)
The static method
AbsSoftTimerManagerInterface::createSoftTimerManager creates a new instance of class SoftTimerManager.
Parameters:
| unsigned long int | base_intervall | | |
| AbsThreadMan * | thrman | | |
Return value:Returns an instance of
SoftTimerManager.
Methods
createSoftTimer (version 1)
Creates a new soft timer.
Signature:
int createSoftTimer(unsigned long int intervall,bool imm,void(*timer_callback)(AbsMsgItem *msg),AbsMsgItem *msg)
Parameters:
| unsigned long int | intervall | | |
| bool | imm | | |
void(*timer_callback)
(
AbsMsgItem *msg
)
with typedef
| SoftTimerCallbackFunction | timer_callback | | [IN] |
The callback function.
Parameter
msg:
|
| AbsMsgItem * | msg | | |
Return value:The timer-id of the new soft timer.
createSoftTimer (version 2)
Creates a new soft timer.
Signature:
int createSoftTimer(unsigned long int intervall,bool imm,AbsThread *thr,AbsMsgItem *msg)
Parameters:
| unsigned long int | intervall | | |
| bool | imm | | |
| AbsThread * | thr | | |
| AbsMsgItem * | msg | | |
Return value:The timer-id of the new soft timer.
destroySoftTimer
Destroys a soft timer.
Signature:
int destroySoftTimer(int timerId)
Parameters:
| int | timerId | | The timer-id of a soft timer, as returned by createSoftTimer(). |
Return value:The function returns 0 on successful deletion of the specified timer. If the timer, with the ID
timerId does not exist, the function returns 1.
startBaseTimer
This resumes execution of a paused SoftTimerManager.
Signature:
void startBaseTimer()
stopBaseTimer
This pauses the execution of the SoftTimerManager.
Signature:
void stopBaseTimer()
updateTimers
Call this to update the list of soft timers.
Signature:
void updateTimers()
This documenta- tion describes the current state of development.
A
aprint 
Implementations: