µOS++ IIIe Reference  v6.3.15
“Perfekt ist nicht gut genug”
The third edition of µOS++, a POSIX inspired open source system, written in C++.
os::rtos::timer::attributes Class Reference

Timer attributes. More...

#include <cmsis-plus/rtos/os.h>

Inherits os::rtos::internal::attributes_clocked.

Inherited by os::rtos::timer::attributes_periodic.

Public Member Functions

Constructors & Destructor
constexpr attributes ()
 Construct a timer attributes object instance. More...
 
 attributes (const attributes &)=default
 
 attributes (attributes &&)=default
 
attributesoperator= (const attributes &)=default
 
attributesoperator= (attributes &&)=default
 
 ~attributes ()=default
 Destruct the timer attributes object instance. More...
 

Public Attributes

Public Member Variables
type_t tm_type = run::once
 Timer type attribute. More...
 
Public Member Variables
rtos::clockclock = nullptr
 Attribute with the address of the clock to be used for timeouts. More...
 

Detailed Description

Timer attributes.

Allow to assign a name to the timer.

To simplify access, the member variables are public and do not require accessors or mutators.

POSIX compatibility
No POSIX similar functionality identified, but inspired by POSIX attributes used in <pthread.h> (IEEE Std 1003.1, 2013 Edition).

Definition at line 131 of file os-timer.h.

Constructor & Destructor Documentation

◆ attributes() [1/3]

constexpr os::rtos::timer::attributes::attributes ( )

Construct a timer attributes object instance.

Parameters
None.

Definition at line 454 of file os-timer.h.

◆ attributes() [2/3]

os::rtos::timer::attributes::attributes ( const attributes )
default

◆ attributes() [3/3]

os::rtos::timer::attributes::attributes ( attributes &&  )
default

◆ ~attributes()

os::rtos::timer::attributes::~attributes ( )
default

Destruct the timer attributes object instance.

Member Function Documentation

◆ operator=() [1/2]

attributes& os::rtos::timer::attributes::operator= ( const attributes )
default

◆ operator=() [2/2]

attributes& os::rtos::timer::attributes::operator= ( attributes &&  )
default

Member Data Documentation

◆ clock

rtos::clock* os::rtos::internal::attributes_clocked::clock = nullptr
inherited

Attribute with the address of the clock to be used for timeouts.

It may be one of os::rtos::sysclock, os::rtos::rtclock, or any other user object derived from class os::rtos::clock.

If nullptr, the default clock is os::rtos::sysclock.

Definition at line 615 of file os-decls.h.

◆ tm_type

type_t os::rtos::timer::attributes::tm_type = run::once

Timer type attribute.

Definition at line 192 of file os-timer.h.


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