TimerAlarmRepeatingDriverRenesas Class Reference

Repeating Timer functions for repeated execution: Plaease use the typedef TimerAlarmRepeating. By default we use a new GPT timer. You can also request 1 AGT timer by calling setTimer(1);. More...

#include <AudioTimerRenesas.h>

Inheritance diagram for TimerAlarmRepeatingDriverRenesas:

Public Member Functions
	TimerAlarmRepeatingDriverRenesas ()
bool	begin (const my_repeating_timer_callback_t callback_f, uint32_t time, TimeUnit unit=MS) override
void *	callbackParameter ()
bool	end ()
	ends the timer and if necessary the task
void	setCallbackParameter (void *obj)
virtual void	setIsSave (bool is_save)
	Not used.
void	setTimer (int timer) override
	Selects the timer type: 0=GPT and 1=AGT.
virtual void	setTimerFunction (TimerFunction function=DirectTimerCallback)

Static Public Member Functions
static void	staticCallback (timer_callback_args_t *ptr)

Protected Member Functions
bool	startAGTTimer (float rate)
bool	startGPTTimer (float rate)
const char *	toString (TimeUnit unit)

Protected Attributes
FspTimer	audio_timer
my_repeating_timer_callback_t	instanceCallback = nullptr
void *	object = nullptr
bool	timer_active = false
uint8_t	timer_type = 0

Detailed Description

Repeating Timer functions for repeated execution: Plaease use the typedef TimerAlarmRepeating. By default we use a new GPT timer. You can also request 1 AGT timer by calling setTimer(1);.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

TimerAlarmRepeatingDriverRenesas()

TimerAlarmRepeatingDriverRenesas ( )

inline

Member Function Documentation

begin()

bool begin ( const my_repeating_timer_callback_t  callback_f, uint32_t  time, TimeUnit  unit = MS  )

inlineoverridevirtual

Starts the alarm timer

Implements TimerAlarmRepeatingDriverBase.

callbackParameter()

void * callbackParameter ( )

inlineinherited

end()

bool end ( )

inlinevirtual

ends the timer and if necessary the task

Reimplemented from TimerAlarmRepeatingDriverBase.

setCallbackParameter()

void setCallbackParameter ( void *  obj )

inlineinherited

setIsSave()

virtual void setIsSave ( bool  is_save )

inlinevirtualinherited

Not used.

setTimer()

void setTimer ( int  timer )

inlineoverridevirtual

Selects the timer type: 0=GPT and 1=AGT.

Reimplemented from TimerAlarmRepeatingDriverBase.

setTimerFunction()

virtual void setTimerFunction ( TimerFunction  function = DirectTimerCallback )

inlinevirtualinherited

startAGTTimer()

bool startAGTTimer ( float  rate )

inlineprotected

startGPTTimer()

bool startGPTTimer ( float  rate )

inlineprotected

staticCallback()

static void staticCallback ( timer_callback_args_t *  ptr )

inlinestatic

toString()

const char * toString ( TimeUnit  unit )

inlineprotectedinherited

Member Data Documentation

audio_timer

FspTimer audio_timer

protected

instanceCallback

my_repeating_timer_callback_t instanceCallback = nullptr

protected

object

void* object = nullptr

protectedinherited

timer_active

bool timer_active = false

protected

timer_type

uint8_t timer_type = 0

protected

---

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

• src/AudioTools/CoreAudio/AudioTimer/AudioTimerRenesas.h