Timer Class

class TimerClass

TimerClass. The Timer Class provides access to a simple scheduler. Reflex routines can be written which will be executed upon expiration of the timer entity. The timer can be set to fire only once, or to repeat at a certain interval.

Public Functions

TimerClass(Acroname::BrainStem::TimerClass &timer)

Constructor.

~TimerClass()

Destructor.

Acroname::BrainStem2CLI::TimerClass::!TimerClass()

Finalizer.

aErr getExpiration(unsigned int %usecDuration)

Get the currently set expiration time in microseconds. This is not a “live” timer. That is, it shows the expiration time originally set with setExpiration; it does not “tick down” to show the time remaining before expiration.

Return

Returns common entity return values

Parameters
  • usecDuration: The timer expiration duration in microseconds.

aErr setExpiration(const int usecDuration)

Set the expiration time for the timer entity. When the timer expires, it will fire the associated timer[index]() reflex.

Return

Returns common entity return values

Parameters
  • usecDuration: The duration before timer expiration in microseconds.

aErr getMode(unsigned char %mode)

Get the mode of the timer which is either single or repeat mode.

Return

Returns common entity return values

Parameters
  • mode: The mode of the time. aTIMER_MODE_REPEAT or aTIMER_MODE_SINGLE.

aErr setMode(const unsigned char mode)

Set the mode of the timer which is either single or repeat mode.

Return

Returns common entity return values

Return

aErrNone - Action completed successfully.

Parameters
  • mode: The mode of the timer. aTIMER_MODE_REPEAT or aTIMER_MODE_SINGLE.