os::rtos::timer::attributes Class Reference

Timer attributes. More...

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

Inheritance diagram for os::rtos::timer::attributes:

Public Member Functions
Constructors & Destructor
constexpr	attributes ()
	Construct a timer attributes object instance.
	attributes (const attributes &)=default
	attributes (attributes &&)=default
attributes &	operator= (const attributes &)=default
attributes &	operator= (attributes &&)=default
	~attributes ()=default
	Destruct the timer attributes object instance.

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

Detailed Description

Allow to assign a name to the timer.

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

If the attributes are modified after the timer creation, the timer attributes shall not be affected.

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 130 of file os-timer.h.

Constructor & Destructor Documentation

attributes() [1/3]

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

constexpr

Parameters

None.

Definition at line 447 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

Member Function Documentation

operator=() [1/2]

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

default

operator=() [2/2]

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

default

Member Data Documentation

clock

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

inherited

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 612 of file os-decls.h.

Referenced by os::rtos::event_flags::event_flags(), os::rtos::mutex::mutex(), and os::rtos::timer::timer().

tm_type

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

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

Referenced by os::rtos::timer::timer(), and osTimerCreate().

---

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

• os-timer.h