os::rtos::condition_variable::attributes Class Reference

Condition variable attributes. More...

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

Inheritance diagram for os::rtos::condition_variable::attributes:

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

Public Attributes
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 condition variable.

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

POSIX compatibility

Inspired by pthread_condattr_t from <pthread.h> (IEEE Std 1003.1, 2013 Edition).

Definition at line 54 of file os-condvar.h.

Constructor & Destructor Documentation

attributes() [1/3]

constexpr os::rtos::condition_variable::attributes::attributes ( )

constexpr

Parameters

None.

Definition at line 303 of file os-condvar.h.

    {
    }

attributes() [2/3]

os::rtos::condition_variable::attributes::attributes ( const attributes &  )

default

attributes() [3/3]

os::rtos::condition_variable::attributes::attributes ( attributes &&  )

default

~attributes()

os::rtos::condition_variable::attributes::~attributes ( )

default

Member Function Documentation

operator=() [1/2]

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

default

operator=() [2/2]

attributes & os::rtos::condition_variable::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().

---

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

• os-condvar.h