os::rtos::timer::attributes_periodic Class Reference

Periodic timer attributes. More...

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

Inheritance diagram for os::rtos::timer::attributes_periodic:

Public Member Functions
Constructors & Destructor
constexpr	attributes_periodic ()
	Construct periodic timer attributes object instance.
	attributes_periodic (const attributes_periodic &)=default
	attributes_periodic (attributes_periodic &&)=default
attributes_periodic &	operator= (const attributes_periodic &)=default
attributes_periodic &	operator= (attributes_periodic &&)=default
	~attributes_periodic ()=default
	Destruct the periodic 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.

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

Constructor & Destructor Documentation

attributes_periodic() [1/3]

constexpr os::rtos::timer::attributes_periodic::attributes_periodic ( )

constexpr

Parameters

None.

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

        : attributes{ run::periodic }
    {
    }

attributes_periodic() [2/3]

os::rtos::timer::attributes_periodic::attributes_periodic ( const attributes_periodic &  )

default

attributes_periodic() [3/3]

os::rtos::timer::attributes_periodic::attributes_periodic ( attributes_periodic &&  )

default

~attributes_periodic()

os::rtos::timer::attributes_periodic::~attributes_periodic ( )

default

Member Function Documentation

operator=() [1/2]

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

default

operator=() [2/2]

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

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

inherited

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