mbed library sources. Supersedes mbed-src.
Dependents: Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more
LowPowerTimeout Class Reference
[Drivers]
Low Power Timout. More...
#include <LowPowerTimeout.h>
Inherits mbed::LowPowerTicker, NonCopyable< LowPowerTimeout >, mbed::LowPowerTicker, and NonCopyable< LowPowerTimeout >.
Public Member Functions | |
void | attach (Callback< void()> func, float t) |
Attach a function to be called by the Ticker, specifying the interval in seconds. | |
void | attach (Callback< void()> func, float t) |
Attach a function to be called by the Ticker, specifying the interval in seconds. | |
template<typename T , typename M > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), t).") void attach(T *obj | |
Attach a member function to be called by the Ticker, specifying the interval in seconds. | |
template<typename T , typename M > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach_us function does not support cv-qualifiers. Replaced by ""attach_us(callback(obj, method), t).") void attach_us(T *obj | |
Attach a member function to be called by the Ticker, specifying the interval in microseconds. | |
template<typename T , typename M > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), t).") void attach(T *obj | |
Attach a member function to be called by the Ticker, specifying the interval in seconds. | |
template<typename T , typename M > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach_us function does not support cv-qualifiers. Replaced by ""attach_us(callback(obj, method), t).") void attach_us(T *obj | |
Attach a member function to be called by the Ticker, specifying the interval in microseconds. | |
Static Public Member Functions | |
static void | irq (uint32_t id) |
The handler registered with the underlying timer interrupt. | |
static void | irq (uint32_t id) |
The handler registered with the underlying timer interrupt. | |
Protected Member Functions | |
void | insert (timestamp_t timestamp) |
Set relative timestamp of the internal event. | |
void | insert (timestamp_t timestamp) |
Set relative timestamp of the internal event. | |
void | insert_absolute (us_timestamp_t timestamp) |
Set absolute timestamp of the internal event. | |
void | insert_absolute (us_timestamp_t timestamp) |
Set absolute timestamp of the internal event. | |
void | remove () |
Remove timestamp. | |
void | remove () |
Remove timestamp. | |
MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &) | |
NonCopyable copy constructor. | |
MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator | |
NonCopyable copy assignment operator. | |
MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &) | |
NonCopyable copy constructor. | |
MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator | |
NonCopyable copy assignment operator. | |
MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &) | |
NonCopyable copy constructor. | |
MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator | |
NonCopyable copy assignment operator. | |
Protected Attributes | |
us_timestamp_t | _delay |
Time delay (in microseconds) for resetting the multishot callback. | |
Callback< void()> | _function |
Callback. | |
bool | _lock_deepsleep |
Flag which indicates if deep sleep should be disabled. | |
Private Member Functions | |
MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &) | |
NonCopyable copy constructor. | |
MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator | |
NonCopyable copy assignment operator. |
Detailed Description
Low Power Timout.
- Note:
- Synchronization level: Interrupt safe
Definition at line 36 of file cmsis/BUILD/mbed/drivers/LowPowerTimeout.h.
Member Function Documentation
void attach | ( | Callback< void()> | func, |
float | t | ||
) | [inherited] |
Attach a function to be called by the Ticker, specifying the interval in seconds.
- Parameters:
-
func pointer to the function to be called t the time between calls in seconds
Definition at line 87 of file cmsis/BUILD/mbed/drivers/Ticker.h.
void attach | ( | Callback< void()> | func, |
float | t | ||
) | [inherited] |
Attach a function to be called by the Ticker, specifying the interval in seconds.
- Parameters:
-
func pointer to the function to be called t the time between calls in seconds
Definition at line 87 of file drivers/Ticker.h.
void insert | ( | timestamp_t | timestamp ) | [protected, inherited] |
Set relative timestamp of the internal event.
- Parameters:
-
timestamp event's us timestamp
- Warning:
- Do not insert more than one timestamp. The same event object is used for every insert/insert_absolute call.
- Ticker's present timestamp is used for reference. For timestamps from the past the event is scheduled after ticker's overflow. For reference
- See also:
- convert_timestamp
Definition at line 47 of file TimerEvent.cpp.
void insert | ( | timestamp_t | timestamp ) | [protected, inherited] |
Set relative timestamp of the internal event.
- Parameters:
-
timestamp event's us timestamp
- Warning:
- Do not insert more than one timestamp. The same event object is used for every insert/insert_absolute call.
- Ticker's present timestamp is used for reference. For timestamps from the past the event is scheduled after ticker's overflow. For reference
- See also:
- convert_timestamp
void insert_absolute | ( | us_timestamp_t | timestamp ) | [protected, inherited] |
Set absolute timestamp of the internal event.
- Parameters:
-
timestamp event's us timestamp
- Warning:
- Do not insert more than one timestamp. The same event object is used for every insert/insert_absolute call.
Definition at line 52 of file TimerEvent.cpp.
void insert_absolute | ( | us_timestamp_t | timestamp ) | [protected, inherited] |
Set absolute timestamp of the internal event.
- Parameters:
-
timestamp event's us timestamp
- Warning:
- Do not insert more than one timestamp. The same event object is used for every insert/insert_absolute call.
void irq | ( | uint32_t | id ) | [static, inherited] |
The handler registered with the underlying timer interrupt.
- Parameters:
-
id Timer Event ID
Definition at line 35 of file TimerEvent.cpp.
static void irq | ( | uint32_t | id ) | [static, inherited] |
The handler registered with the underlying timer interrupt.
- Parameters:
-
id Timer Event ID
MBED_DEPRECATED | ( | "Invalid copy construction of a NonCopyable< LowPowerTicker > resource." | ) | const [protected, inherited] |
NonCopyable copy constructor.
A compile time warning is issued when this function is used, and a runtime warning is printed when the copy construction of the noncopyable happens.
If you see this warning, your code is probably doing something unspecified. Copying of noncopyable resources can lead to resource leak and random error.
Definition at line 190 of file cmsis/BUILD/mbed/platform/NonCopyable.h.
MBED_DEPRECATED | ( | "Invalid copy construction of a NonCopyable< TimerEvent > resource." | ) | const [protected, inherited] |
NonCopyable copy constructor.
A compile time warning is issued when this function is used, and a runtime warning is printed when the copy construction of the noncopyable happens.
If you see this warning, your code is probably doing something unspecified. Copying of noncopyable resources can lead to resource leak and random error.
Definition at line 190 of file cmsis/BUILD/mbed/platform/NonCopyable.h.
MBED_DEPRECATED | ( | "Invalid copy assignment of a NonCopyable< TimerEvent > resource." | ) | [protected, inherited] |
NonCopyable copy assignment operator.
A compile time warning is issued when this function is used, and a runtime warning is printed when the copy construction of the noncopyable happens.
If you see this warning, your code is probably doing something unspecified. Copying of noncopyable resources can lead to resource leak and random error.
MBED_DEPRECATED | ( | "Invalid copy assignment of a NonCopyable< Ticker > resource." | ) | [protected, inherited] |
NonCopyable copy assignment operator.
A compile time warning is issued when this function is used, and a runtime warning is printed when the copy construction of the noncopyable happens.
If you see this warning, your code is probably doing something unspecified. Copying of noncopyable resources can lead to resource leak and random error.
MBED_DEPRECATED | ( | "Invalid copy assignment of a NonCopyable< LowPowerTicker > resource." | ) | [protected, inherited] |
NonCopyable copy assignment operator.
A compile time warning is issued when this function is used, and a runtime warning is printed when the copy construction of the noncopyable happens.
If you see this warning, your code is probably doing something unspecified. Copying of noncopyable resources can lead to resource leak and random error.
MBED_DEPRECATED | ( | "Invalid copy construction of a NonCopyable< Ticker > resource." | ) | const [protected, inherited] |
NonCopyable copy constructor.
A compile time warning is issued when this function is used, and a runtime warning is printed when the copy construction of the noncopyable happens.
If you see this warning, your code is probably doing something unspecified. Copying of noncopyable resources can lead to resource leak and random error.
Definition at line 190 of file cmsis/BUILD/mbed/platform/NonCopyable.h.
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
"The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), t)." | |||
) | [inherited] |
Attach a member function to be called by the Ticker, specifying the interval in seconds.
- Parameters:
-
obj pointer to the object to call the member function on method pointer to the member function to be called t the time between calls in seconds
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
"The attach_us function does not support cv-qualifiers. Replaced by ""attach_us(callback(obj, method), t)." | |||
) | [inherited] |
Attach a member function to be called by the Ticker, specifying the interval in microseconds.
- Parameters:
-
obj pointer to the object to call the member function on method pointer to the member function to be called t the time between calls in microseconds
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
"The attach_us function does not support cv-qualifiers. Replaced by ""attach_us(callback(obj, method), t)." | |||
) | [inherited] |
Attach a member function to be called by the Ticker, specifying the interval in microseconds.
- Parameters:
-
obj pointer to the object to call the member function on method pointer to the member function to be called t the time between calls in microseconds
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
"The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), t)." | |||
) | [inherited] |
Attach a member function to be called by the Ticker, specifying the interval in seconds.
- Parameters:
-
obj pointer to the object to call the member function on method pointer to the member function to be called t the time between calls in seconds
void remove | ( | ) | [protected, inherited] |
Remove timestamp.
Definition at line 57 of file TimerEvent.cpp.
void remove | ( | ) | [protected, inherited] |
Remove timestamp.
Field Documentation
us_timestamp_t _delay [protected, inherited] |
Time delay (in microseconds) for resetting the multishot callback.
Definition at line 155 of file cmsis/BUILD/mbed/drivers/Ticker.h.
Callback< void()> _function [protected, inherited] |
Callback.
Definition at line 156 of file cmsis/BUILD/mbed/drivers/Ticker.h.
bool _lock_deepsleep [protected, inherited] |
Flag which indicates if deep sleep should be disabled.
Definition at line 157 of file cmsis/BUILD/mbed/drivers/Ticker.h.
Generated on Tue Jul 12 2022 20:41:17 by 1.7.2