Damian Gabino / picoGW_mcu
Embed: (wiki syntax)

« Back to documentation index

LowPowerTicker Class Reference

Low Power Ticker. More...

#include <LowPowerTicker.h>

Inherits mbed::Ticker, and mbed::Ticker.

Inherited by LowPowerTimeout, and LowPowerTimeout.

Public Member Functions

void attach (Callback< void()> func, float t)
 Attach a function to be called by the Ticker, specifiying the interval in seconds.
template<typename T , typename M >
void attach (T *obj, M method, float t)
 Attach a member function to be called by the Ticker, specifiying the interval in seconds.
void attach (Callback< void()> func, float t)
 Attach a function to be called by the Ticker, specifiying the interval in seconds.
template<typename T , typename M >
void attach (T *obj, M method, float t)
 Attach a member function to be called by the Ticker, specifiying the interval in seconds.
void attach_us (Callback< void()> func, timestamp_t t)
 Attach a function to be called by the Ticker, specifiying the interval in micro-seconds.
template<typename T , typename M >
void attach_us (T *obj, M method, timestamp_t t)
 Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds.
void attach_us (Callback< void()> func, timestamp_t t)
 Attach a function to be called by the Ticker, specifiying the interval in micro-seconds.
template<typename T , typename M >
void attach_us (T *obj, M method, timestamp_t t)
 Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds.
void detach ()
 Detach the function.
void detach ()
 Detach the function.

Static Public Member Functions

static void irq (uint32_t id)
 The handler registered with the underlying timer interrupt.

Protected Attributes

timestamp_t _delay
 Time delay (in microseconds) for re-setting the multi-shot callback.
Callback< void()> _function
 Callback.

Detailed Description

Low Power Ticker.

Synchronization level: Interrupt safe

Definition at line 32 of file mbed-dev/api/LowPowerTicker.h.


Member Function Documentation

void attach ( Callback< void()>  func,
float  t 
) [inherited]

Attach a function to be called by the Ticker, specifiying the interval in seconds.

Parameters:
funcpointer to the function to be called
tthe time between calls in seconds

Definition at line 74 of file mbed-dev/api/Ticker.h.

void attach ( T *  obj,
method,
float  t 
) [inherited]

Attach a member function to be called by the Ticker, specifiying the interval in seconds.

Parameters:
objpointer to the object to call the member function on
methodpointer to the member function to be called
tthe time between calls in seconds

Definition at line 85 of file mbed-dev/api/Ticker.h.

void attach ( T *  obj,
method,
float  t 
) [inherited]

Attach a member function to be called by the Ticker, specifiying the interval in seconds.

Parameters:
objpointer to the object to call the member function on
methodpointer to the member function to be called
tthe time between calls in seconds

Definition at line 85 of file usb_cdc/mbed-dev/api/Ticker.h.

void attach ( Callback< void()>  func,
float  t 
) [inherited]

Attach a function to be called by the Ticker, specifiying the interval in seconds.

Parameters:
funcpointer to the function to be called
tthe time between calls in seconds

Definition at line 74 of file usb_cdc/mbed-dev/api/Ticker.h.

void attach_us ( T *  obj,
method,
timestamp_t  t 
) [inherited]

Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds.

Parameters:
tptrpointer to the object to call the member function on
mptrpointer to the member function to be called
tthe time between calls in micro-seconds

Definition at line 106 of file usb_cdc/mbed-dev/api/Ticker.h.

void attach_us ( Callback< void()>  func,
timestamp_t  t 
) [inherited]

Attach a function to be called by the Ticker, specifiying the interval in micro-seconds.

Parameters:
fptrpointer to the function to be called
tthe time between calls in micro-seconds

Definition at line 94 of file mbed-dev/api/Ticker.h.

void attach_us ( T *  obj,
method,
timestamp_t  t 
) [inherited]

Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds.

Parameters:
tptrpointer to the object to call the member function on
mptrpointer to the member function to be called
tthe time between calls in micro-seconds

Definition at line 106 of file mbed-dev/api/Ticker.h.

void attach_us ( Callback< void()>  func,
timestamp_t  t 
) [inherited]

Attach a function to be called by the Ticker, specifiying the interval in micro-seconds.

Parameters:
fptrpointer to the function to be called
tthe time between calls in micro-seconds

Definition at line 94 of file usb_cdc/mbed-dev/api/Ticker.h.

void detach (  ) [inherited]

Detach the function.

Definition at line 25 of file Ticker.cpp.

void detach (  ) [inherited]

Detach the function.

void irq ( uint32_t  id ) [static, inherited]

The handler registered with the underlying timer interrupt.

Definition at line 33 of file TimerEvent.cpp.


Field Documentation

timestamp_t _delay [protected, inherited]

Time delay (in microseconds) for re-setting the multi-shot callback.

Definition at line 123 of file mbed-dev/api/Ticker.h.

Callback< void()> _function [protected, inherited]

Callback.

Definition at line 124 of file mbed-dev/api/Ticker.h.