Class to store and manage a Common QoS configuration. More...

#include <CommonQos.hpp>

Public Member Functions
	CommonQos () noexcept=default
	Default constructor. More...

virtual	~CommonQos () noexcept=default
	Virtual destructor. More...

	CommonQos (const CommonQos &) noexcept=default
	Copy constructor. More...

	CommonQos (CommonQos &&) noexcept=default
	Move constructor. More...

CommonQos &	operator= (const CommonQos &) noexcept=default
	Assignment operator. More...

CommonQos &	operator= (CommonQos &&) noexcept=default
	Move assignment operator. More...

DurabilityQosPolicy &	durability () &noexcept
	Getter for DurabilityQosPolicy. Can only be used on lvalue objects. More...

DeadlineQosPolicy &	deadline () &noexcept
	Getter for DeadlineQosPolicy. Can only be used on lvalue objects. More...

LivelinessQosPolicy &	liveliness () &noexcept
	Getter for LivelinessQosPolicy. Can only be used on lvalue objects. More...

ReliabilityQosPolicy &	reliability () &noexcept
	Getter for ReliabilityQosPolicy. Can only be used on lvalue objects. More...

HistoryQosPolicy &	history () &noexcept
	Getter for HistoryQosPolicy. Can only be used on lvalue objects. More...

ResourceLimitsQosPolicy &	resource_limits () &noexcept
	Getter for ResourceLimitsQosPolicy. Can only be used on lvalue objects. More...

OwnershipQosPolicy &	ownership () &noexcept
	Getter for OwnershipQosPolicy. Can only be used on lvalue objects. More...

LatencyBudgetQosPolicy &	latency_budget () &noexcept
	Getter for LatencyBudgetQosPolicy. Can only be used on lvalue objects. More...

DestinationOrderQosPolicy &	destination_order () &noexcept
	Getter for DestinationOrderQosPolicy. Can only be used on lvalue objects. More...

const DurabilityQosPolicy &	durability () const &&noexcept=delete
	Deleted const DurabilityQosPolicy getter for DurabilityQosPolicy on rvalue objects. More...

const DurabilityQosPolicy &	durability () const &noexcept
	Const getter for DurabilityQosPolicy. Can only be used on lvalue objects. More...

const DeadlineQosPolicy &	deadline () const &&noexcept=delete
	Deleted const getter for DeadlineQosPolicy on rvalue objects. More...

const DeadlineQosPolicy &	deadline () const &noexcept
	Const getter for DeadlineQosPolicy. Can only be used on lvalue objects. More...

const LivelinessQosPolicy &	liveliness () const &&noexcept=delete
	Deleted const getter for LivelinessQosPolicy on rvalue objects. More...

const LivelinessQosPolicy &	liveliness () const &noexcept
	Const getter for LivelinessQosPolicy. Can only be used on lvalue objects. More...

const ReliabilityQosPolicy &	reliability () const &&noexcept=delete
	Deleted const getter for ReliabilityQosPolicy on rvalue objects. More...

const ReliabilityQosPolicy &	reliability () const &noexcept
	Const getter for ReliabilityQosPolicy. Can only be used on lvalue objects. More...

const HistoryQosPolicy &	history () const &&noexcept=delete
	Deleted const getter for HistoryQosPolicy on rvalue objects. More...

const HistoryQosPolicy &	history () const &noexcept
	Const getter for HistoryQosPolicy. Can only be used on lvalue objects. More...

const ResourceLimitsQosPolicy &	resource_limits () const &&noexcept=delete
	Deleted const getter for ResourceLimitsQosPolicy on rvalue objects. More...

const ResourceLimitsQosPolicy &	resource_limits () const &noexcept
	Const getter for ResourceLimitsQosPolicy. Can only be used on lvalue objects. More...

const OwnershipQosPolicy &	ownership () const &&noexcept=delete
	Deleted const getter for OwnershipQosPolicy on rvalue objects. More...

const OwnershipQosPolicy &	ownership () const &noexcept
	Const getter for OwnershipQosPolicy. Can only be used on lvalue objects. More...

const LatencyBudgetQosPolicy &	latency_budget () const &&noexcept=delete
	Deleted const getter for LatencyBudgetQosPolicy on rvalue objects. More...

const LatencyBudgetQosPolicy &	latency_budget () const &noexcept
	Const getter for LatencyBudgetQosPolicy. Can only be used on lvalue objects. More...

const DestinationOrderQosPolicy &	destination_order () const &&noexcept=delete
	Deleted const getter for DestinationOrderQosPolicy on rvalue objects. More...

const DestinationOrderQosPolicy &	destination_order () const &noexcept
	Const getter for DestinationOrderQosPolicy. Can only be used on lvalue objects. More...

virtual ReturnCode	is_supported () const noexcept
	Check all QoS policies are supported. More...

virtual ReturnCode	is_consistent () const noexcept
	Check if configured Qos values are consistent. More...

Protected Attributes
DurabilityQosPolicy	durability_
	Durability QoS policy. More...

DeadlineQosPolicy	deadline_
	Deadline QoS policy. More...

LivelinessQosPolicy	liveliness_
	Liveliness QoS policy. More...

ReliabilityQosPolicy	reliability_
	Reliability QoS policy. More...

HistoryQosPolicy	history_
	History QoS policy. More...

ResourceLimitsQosPolicy	resource_limits_
	Resource limits QoS policy. More...

OwnershipQosPolicy	ownership_
	Ownership QoS policy. More...

LatencyBudgetQosPolicy	latency_budget_
	Latency Budget QoS policy. More...

DestinationOrderQosPolicy	destination_order_
	Destination Order QoS policy. More...

Detailed Description

Class to store and manage a Common QoS configuration.

Constructor & Destructor Documentation

◆ CommonQos() [1/3]

eprosima::safedds::dds::CommonQos::CommonQos ( )

explicitdefaultnoexcept

Default constructor.

◆ ~CommonQos()

virtual eprosima::safedds::dds::CommonQos::~CommonQos ( )

virtualdefaultnoexcept

Virtual destructor.

◆ CommonQos() [2/3]

eprosima::safedds::dds::CommonQos::CommonQos ( const CommonQos & )

defaultnoexcept

Copy constructor.

◆ CommonQos() [3/3]

eprosima::safedds::dds::CommonQos::CommonQos ( CommonQos && )

defaultnoexcept

Move constructor.

Member Function Documentation

◆ deadline() [1/3]

DeadlineQosPolicy& eprosima::safedds::dds::CommonQos::deadline ( ) &

noexcept

Getter for DeadlineQosPolicy. Can only be used on lvalue objects.

Returns: DeadlineQosPolicy

◆ deadline() [2/3]

const DeadlineQosPolicy& eprosima::safedds::dds::CommonQos::deadline ( ) const &&

deletenoexcept

Deleted const getter for DeadlineQosPolicy on rvalue objects.

◆ deadline() [3/3]

const DeadlineQosPolicy& eprosima::safedds::dds::CommonQos::deadline ( ) const &

noexcept

Const getter for DeadlineQosPolicy. Can only be used on lvalue objects.

Returns: DeadlineQosPolicy

◆ destination_order() [1/3]

DestinationOrderQosPolicy& eprosima::safedds::dds::CommonQos::destination_order ( ) &

noexcept

Getter for DestinationOrderQosPolicy. Can only be used on lvalue objects.

Returns: DestinationOrderQosPolicy

◆ destination_order() [2/3]

const DestinationOrderQosPolicy& eprosima::safedds::dds::CommonQos::destination_order ( ) const &&

deletenoexcept

Deleted const getter for DestinationOrderQosPolicy on rvalue objects.

◆ destination_order() [3/3]

const DestinationOrderQosPolicy& eprosima::safedds::dds::CommonQos::destination_order ( ) const &

noexcept

Const getter for DestinationOrderQosPolicy. Can only be used on lvalue objects.

Returns: DestinationOrderQosPolicy

◆ durability() [1/3]

DurabilityQosPolicy& eprosima::safedds::dds::CommonQos::durability ( ) &

noexcept

Getter for DurabilityQosPolicy. Can only be used on lvalue objects.

Returns: DurabilityQosPolicy

◆ durability() [2/3]

const DurabilityQosPolicy& eprosima::safedds::dds::CommonQos::durability ( ) const &&

deletenoexcept

Deleted const DurabilityQosPolicy getter for DurabilityQosPolicy on rvalue objects.

◆ durability() [3/3]

const DurabilityQosPolicy& eprosima::safedds::dds::CommonQos::durability ( ) const &

noexcept

Const getter for DurabilityQosPolicy. Can only be used on lvalue objects.

Returns: DurabilityQosPolicy

◆ history() [1/3]

HistoryQosPolicy& eprosima::safedds::dds::CommonQos::history ( ) &

noexcept

Getter for HistoryQosPolicy. Can only be used on lvalue objects.

Returns: HistoryQosPolicy

◆ history() [2/3]

const HistoryQosPolicy& eprosima::safedds::dds::CommonQos::history ( ) const &&

deletenoexcept

Deleted const getter for HistoryQosPolicy on rvalue objects.

◆ history() [3/3]

const HistoryQosPolicy& eprosima::safedds::dds::CommonQos::history ( ) const &

noexcept

Const getter for HistoryQosPolicy. Can only be used on lvalue objects.

Returns: HistoryQosPolicy

◆ is_consistent()

virtual ReturnCode eprosima::safedds::dds::CommonQos::is_consistent ( ) const

virtualnoexcept

Check if configured Qos values are consistent.

Returns: ReturnCode.

Reimplemented in eprosima::safedds::dds::EndpointQos, eprosima::safedds::dds::DataWriterQos, and eprosima::safedds::dds::DataReaderQos.

◆ is_supported()

virtual ReturnCode eprosima::safedds::dds::CommonQos::is_supported ( ) const

virtualnoexcept

Check all QoS policies are supported.

Returns: ReturnCode.

Reimplemented in eprosima::safedds::dds::TopicQos, eprosima::safedds::dds::EndpointQos, eprosima::safedds::dds::DataWriterQos, and eprosima::safedds::dds::DataReaderQos.

◆ latency_budget() [1/3]

LatencyBudgetQosPolicy& eprosima::safedds::dds::CommonQos::latency_budget ( ) &

noexcept

Getter for LatencyBudgetQosPolicy. Can only be used on lvalue objects.

Returns: LatencyBudgetQosPolicy

◆ latency_budget() [2/3]

const LatencyBudgetQosPolicy& eprosima::safedds::dds::CommonQos::latency_budget ( ) const &&

deletenoexcept

Deleted const getter for LatencyBudgetQosPolicy on rvalue objects.

◆ latency_budget() [3/3]

const LatencyBudgetQosPolicy& eprosima::safedds::dds::CommonQos::latency_budget ( ) const &

noexcept

Const getter for LatencyBudgetQosPolicy. Can only be used on lvalue objects.

Returns: LatencyBudgetQosPolicy

◆ liveliness() [1/3]

LivelinessQosPolicy& eprosima::safedds::dds::CommonQos::liveliness ( ) &

noexcept

Getter for LivelinessQosPolicy. Can only be used on lvalue objects.

Returns: LivelinessQosPolicy

◆ liveliness() [2/3]

const LivelinessQosPolicy& eprosima::safedds::dds::CommonQos::liveliness ( ) const &&

deletenoexcept

Deleted const getter for LivelinessQosPolicy on rvalue objects.

◆ liveliness() [3/3]

const LivelinessQosPolicy& eprosima::safedds::dds::CommonQos::liveliness ( ) const &

noexcept

Const getter for LivelinessQosPolicy. Can only be used on lvalue objects.

Returns: LivelinessQosPolicy

◆ operator=() [1/2]

CommonQos& eprosima::safedds::dds::CommonQos::operator= ( CommonQos && )

defaultnoexcept

Move assignment operator.

Returns: CommonQos

◆ operator=() [2/2]

CommonQos& eprosima::safedds::dds::CommonQos::operator= ( const CommonQos & )

defaultnoexcept

Assignment operator.

Returns: CommonQos

◆ ownership() [1/3]

OwnershipQosPolicy& eprosima::safedds::dds::CommonQos::ownership ( ) &

noexcept

Getter for OwnershipQosPolicy. Can only be used on lvalue objects.

Returns: OwnershipQosPolicy

◆ ownership() [2/3]

const OwnershipQosPolicy& eprosima::safedds::dds::CommonQos::ownership ( ) const &&

deletenoexcept

Deleted const getter for OwnershipQosPolicy on rvalue objects.

◆ ownership() [3/3]

const OwnershipQosPolicy& eprosima::safedds::dds::CommonQos::ownership ( ) const &

noexcept

Const getter for OwnershipQosPolicy. Can only be used on lvalue objects.

Returns: OwnershipQosPolicy

◆ reliability() [1/3]

ReliabilityQosPolicy& eprosima::safedds::dds::CommonQos::reliability ( ) &

noexcept

Getter for ReliabilityQosPolicy. Can only be used on lvalue objects.

Returns: ReliabilityQosPolicy

◆ reliability() [2/3]

const ReliabilityQosPolicy& eprosima::safedds::dds::CommonQos::reliability ( ) const &&

deletenoexcept

Deleted const getter for ReliabilityQosPolicy on rvalue objects.

◆ reliability() [3/3]

const ReliabilityQosPolicy& eprosima::safedds::dds::CommonQos::reliability ( ) const &

noexcept

Const getter for ReliabilityQosPolicy. Can only be used on lvalue objects.

Returns: ReliabilityQosPolicy

◆ resource_limits() [1/3]

ResourceLimitsQosPolicy& eprosima::safedds::dds::CommonQos::resource_limits ( ) &

noexcept

Getter for ResourceLimitsQosPolicy. Can only be used on lvalue objects.

Returns: ResourceLimitsQosPolicy

◆ resource_limits() [2/3]

const ResourceLimitsQosPolicy& eprosima::safedds::dds::CommonQos::resource_limits ( ) const &&

deletenoexcept

Deleted const getter for ResourceLimitsQosPolicy on rvalue objects.

◆ resource_limits() [3/3]

const ResourceLimitsQosPolicy& eprosima::safedds::dds::CommonQos::resource_limits ( ) const &

noexcept

Const getter for ResourceLimitsQosPolicy. Can only be used on lvalue objects.

Returns: ResourceLimitsQosPolicy

Member Data Documentation

◆ deadline_

DeadlineQosPolicy eprosima::safedds::dds::CommonQos::deadline_

protected

Deadline QoS policy.

◆ destination_order_

DestinationOrderQosPolicy eprosima::safedds::dds::CommonQos::destination_order_

protected

Destination Order QoS policy.

◆ durability_

DurabilityQosPolicy eprosima::safedds::dds::CommonQos::durability_

protected

Durability QoS policy.

◆ history_

HistoryQosPolicy eprosima::safedds::dds::CommonQos::history_

protected

History QoS policy.

◆ latency_budget_

LatencyBudgetQosPolicy eprosima::safedds::dds::CommonQos::latency_budget_

protected

Latency Budget QoS policy.

◆ liveliness_

LivelinessQosPolicy eprosima::safedds::dds::CommonQos::liveliness_

protected

Liveliness QoS policy.

◆ ownership_

OwnershipQosPolicy eprosima::safedds::dds::CommonQos::ownership_

protected

Ownership QoS policy.

◆ reliability_

ReliabilityQosPolicy eprosima::safedds::dds::CommonQos::reliability_

protected

Reliability QoS policy.

◆ resource_limits_

ResourceLimitsQosPolicy eprosima::safedds::dds::CommonQos::resource_limits_

protected

Resource limits QoS policy.

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

build/docs/user_manual/main/tmp/include/safedds/dds/qos/CommonQos.hpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CommonQos() [1/3]

◆ ~CommonQos()

◆ CommonQos() [2/3]

◆ CommonQos() [3/3]

Member Function Documentation

◆ deadline() [1/3]

◆ deadline() [2/3]

◆ deadline() [3/3]

◆ destination_order() [1/3]

◆ destination_order() [2/3]

◆ destination_order() [3/3]

◆ durability() [1/3]

◆ durability() [2/3]

◆ durability() [3/3]

◆ history() [1/3]

◆ history() [2/3]

◆ history() [3/3]

◆ is_consistent()

◆ is_supported()

◆ latency_budget() [1/3]

◆ latency_budget() [2/3]

◆ latency_budget() [3/3]

◆ liveliness() [1/3]

◆ liveliness() [2/3]

◆ liveliness() [3/3]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ownership() [1/3]

◆ ownership() [2/3]

◆ ownership() [3/3]

◆ reliability() [1/3]

◆ reliability() [2/3]

◆ reliability() [3/3]

◆ resource_limits() [1/3]

◆ resource_limits() [2/3]

◆ resource_limits() [3/3]

Member Data Documentation

◆ deadline_

◆ destination_order_

◆ durability_

◆ history_

◆ latency_budget_

◆ liveliness_

◆ ownership_

◆ reliability_

◆ resource_limits_