mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

Embed: (wiki syntax)

« Back to documentation index

TimerEvent Class Reference

Base abstraction for timer interrupts. More...

#include <TimerEvent.h>

Inherits NonCopyable< TimerEvent >, and NonCopyable< TimerEvent >.

Inherited by Ticker, and Ticker.

Public Member Functions

virtual ~TimerEvent ()
 Destruction removes it...
virtual ~TimerEvent ()
 Destruction removes it...

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_absolute (us_timestamp_t timestamp)
 Set absolute timestamp of the internal event.
void remove ()
 Remove timestamp.
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 remove ()
 Remove timestamp.

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.
 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

Base abstraction for timer interrupts.

Note:
Synchronization level: Interrupt safe

Definition at line 32 of file cmsis/BUILD/mbed/drivers/TimerEvent.h.


Constructor & Destructor Documentation

~TimerEvent (  ) [virtual]

Destruction removes it...

Definition at line 41 of file TimerEvent.cpp.

virtual ~TimerEvent (  ) [virtual]

Destruction removes it...


Member Function Documentation

void insert ( timestamp_t  timestamp ) [protected]

Set relative timestamp of the internal event.

Parameters:
timestampevent'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 ( timestamp_t  timestamp ) [protected]

Set relative timestamp of the internal event.

Parameters:
timestampevent'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_absolute ( us_timestamp_t  timestamp ) [protected]

Set absolute timestamp of the internal event.

Parameters:
timestampevent's us timestamp
Warning:
Do not insert more than one timestamp. The same event object is used for every insert/insert_absolute call.
void insert_absolute ( us_timestamp_t  timestamp ) [protected]

Set absolute timestamp of the internal event.

Parameters:
timestampevent'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.

static void irq ( uint32_t  id ) [static]

The handler registered with the underlying timer interrupt.

Parameters:
idTimer Event ID
void irq ( uint32_t  id ) [static]

The handler registered with the underlying timer interrupt.

Parameters:
idTimer Event ID

Definition at line 35 of file TimerEvent.cpp.

void remove (  ) [protected]

Remove timestamp.

void remove (  ) [protected]

Remove timestamp.

Definition at line 57 of file TimerEvent.cpp.