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

#include <EndpointQos.hpp>

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

	~EndpointQos () noexcept override=default
	Destructor. More...

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

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

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

EndpointQos &	operator= (EndpointQos &&other) noexcept=default
	Move assignment operator. More...

PartitionQosPolicy &	partition () &noexcept
	Getter for PartitionQosPolicy. Can only be used on lvalue objects. More...

PresentationQosPolicy &	presentation () &noexcept
	Getter for PresentationQosPolicy. Can only be used on lvalue objects. More...

const PartitionQosPolicy &	partition () const &&noexcept=delete
	Deleted const getter for PartitionQosPolicy on rvalue objects. More...

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

const PresentationQosPolicy &	presentation () const &&noexcept=delete
	Deleted const getter for PresentationQosPolicy on rvalue objects. More...

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

UserDataQosPolicy &	user_data () &noexcept
	Getter for UserDataQosPolicy. Can only be used on lvalue objects. More...

const UserDataQosPolicy &	user_data () const &&noexcept=delete
	Deleted const getter for UserDataQosPolicy on rvalue objects. More...

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

DataRepresentationQosPolicy &	representation () &noexcept
	Getter for DataRepresentationQosPolicy. Can only be used on lvalue objects. More...

const DataRepresentationQosPolicy &	representation () const &&noexcept=delete
	Deleted const getter for DataRepresentationQosPolicy on rvalue objects. More...

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

CommonQos &	common_qos () &noexcept
	Get CommonQos. Can only be used on lvalue objects. More...

const CommonQos &	common_qos () const &&noexcept=delete
	Deleted const getter for CommonQos on rvalue objects. More...

const CommonQos &	common_qos () const &noexcept
	Get const CommonQos. Can only be used on lvalue objects. More...

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

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

DurabilityQosPolicy &	durability () &noexcept
	Expose parent durability getter method. More...

const DurabilityQosPolicy &	durability () const &&noexcept=delete
	Expose parent durability getter method. More...

const DurabilityQosPolicy &	durability () const &noexcept
	Expose parent durability getter method. More...

DeadlineQosPolicy &	deadline () &noexcept
	Expose parent deadline getter method. More...

const DeadlineQosPolicy &	deadline () const &&noexcept=delete
	Expose parent deadline getter method. More...

const DeadlineQosPolicy &	deadline () const &noexcept
	Expose parent deadline getter method. More...

LivelinessQosPolicy &	liveliness () &noexcept
	Expose parent liveliness getter method. More...

const LivelinessQosPolicy &	liveliness () const &&noexcept=delete
	Expose parent liveliness getter method. More...

const LivelinessQosPolicy &	liveliness () const &noexcept
	Expose parent liveliness getter method. More...

ReliabilityQosPolicy &	reliability () &noexcept
	Expose parent reliability getter method. More...

const ReliabilityQosPolicy &	reliability () const &&noexcept=delete
	Expose parent reliability getter method. More...

const ReliabilityQosPolicy &	reliability () const &noexcept
	Expose parent reliability getter method. More...

HistoryQosPolicy &	history () &noexcept
	Expose parent history getter method. More...

const HistoryQosPolicy &	history () const &&noexcept=delete
	Expose parent history getter method. More...

const HistoryQosPolicy &	history () const &noexcept
	Expose parent history getter method. More...

ResourceLimitsQosPolicy &	resource_limits () &noexcept
	Expose parent resource_limits getter method. More...

const ResourceLimitsQosPolicy &	resource_limits () const &&noexcept=delete
	Expose parent resource_limits getter method. More...

const ResourceLimitsQosPolicy &	resource_limits () const &noexcept
	Expose parent resource_limits getter method. More...

OwnershipQosPolicy &	ownership () &noexcept
	Expose parent ownership getter method. More...

const OwnershipQosPolicy &	ownership () const &&noexcept=delete
	Expose parent ownership getter method. More...

const OwnershipQosPolicy &	ownership () const &noexcept
	Expose parent ownership getter method. More...

LatencyBudgetQosPolicy &	latency_budget () &noexcept
	Expose parent latency_budget getter method. More...

const LatencyBudgetQosPolicy &	latency_budget () const &&noexcept=delete
	Expose parent latency_budget getter method. More...

const LatencyBudgetQosPolicy &	latency_budget () const &noexcept
	Expose parent latency_budget getter method. More...

DestinationOrderQosPolicy &	destination_order () &noexcept
	Expose parent destination_order getter method. More...

const DestinationOrderQosPolicy &	destination_order () const &&noexcept=delete
	Expose parent destination_order getter method. More...

const DestinationOrderQosPolicy &	destination_order () const &noexcept
	Expose parent destination_order getter method. More...

Protected Attributes
PartitionQosPolicy	partition_
	Partition QoS policy. More...

PresentationQosPolicy	presentation_
	Presentation QoS policy. More...

UserDataQosPolicy	user_data_
	User data QoS policy. More...

DataRepresentationQosPolicy	representation_
	Data representation QoS policy. More...

Protected Attributes inherited from eprosima::safedds::dds::CommonQos
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...

Additional Inherited Members
Protected Member Functions inherited from eprosima::safedds::dds::CommonQos
	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...

Detailed Description

Class to store and manage a Endpoint QoS configuration.

Constructor & Destructor Documentation

◆ EndpointQos() [1/3]

eprosima::safedds::dds::EndpointQos::EndpointQos ( )

defaultnoexcept

Default constructor.

◆ ~EndpointQos()

eprosima::safedds::dds::EndpointQos::~EndpointQos ( )

overridedefaultnoexcept

Destructor.

◆ EndpointQos() [2/3]

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

defaultnoexcept

Copy constructor.

◆ EndpointQos() [3/3]

eprosima::safedds::dds::EndpointQos::EndpointQos ( EndpointQos && )

defaultnoexcept

Move constructor.

Member Function Documentation

◆ common_qos() [1/3]

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

noexcept

Get CommonQos. Can only be used on lvalue objects.

Returns: CommonQos&

◆ common_qos() [2/3]

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

deletenoexcept

Deleted const getter for CommonQos on rvalue objects.

◆ common_qos() [3/3]

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

noexcept

Get const CommonQos. Can only be used on lvalue objects.

Returns: CommonQos&

◆ deadline() [1/3]

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

noexcept

Expose parent deadline getter method.

Returns: DeadlineQosPolicy

◆ deadline() [2/3]

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

deletenoexcept

Expose parent deadline getter method.

Returns: DeadlineQosPolicy

◆ deadline() [3/3]

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

noexcept

Expose parent deadline getter method.

Returns: DeadlineQosPolicy

◆ destination_order() [1/3]

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

noexcept

Expose parent destination_order getter method.

Returns: DestinationOrderQosPolicy

◆ destination_order() [2/3]

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

deletenoexcept

Expose parent destination_order getter method.

Returns: DestinationOrderQosPolicy

◆ destination_order() [3/3]

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

noexcept

Expose parent destination_order getter method.

Returns: DestinationOrderQosPolicy

◆ durability() [1/3]

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

noexcept

Expose parent durability getter method.

Returns: DurabilityQosPolicy

◆ durability() [2/3]

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

deletenoexcept

Expose parent durability getter method.

Returns: DurabilityQosPolicy

◆ durability() [3/3]

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

noexcept

Expose parent durability getter method.

Returns: DurabilityQosPolicy

◆ history() [1/3]

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

noexcept

Expose parent history getter method.

Returns: HistoryQosPolicy

◆ history() [2/3]

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

deletenoexcept

Expose parent history getter method.

Returns: HistoryQosPolicy

◆ history() [3/3]

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

noexcept

Expose parent history getter method.

Returns: HistoryQosPolicy

◆ is_consistent()

ReturnCode eprosima::safedds::dds::EndpointQos::is_consistent ( ) const

overridevirtualnoexcept

Check if configured Qos values are consistent.

Returns: ReturnCode.

Reimplemented from eprosima::safedds::dds::CommonQos.

◆ is_supported()

ReturnCode eprosima::safedds::dds::EndpointQos::is_supported ( ) const

overridevirtualnoexcept

Check all QoS policies are supported.

Returns: ReturnCode.

Reimplemented from eprosima::safedds::dds::CommonQos.

◆ latency_budget() [1/3]

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

noexcept

Expose parent latency_budget getter method.

Returns: LatencyBudgetQosPolicy

◆ latency_budget() [2/3]

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

deletenoexcept

Expose parent latency_budget getter method.

Returns: LatencyBudgetQosPolicy

◆ latency_budget() [3/3]

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

noexcept

Expose parent latency_budget getter method.

Returns: LatencyBudgetQosPolicy

◆ liveliness() [1/3]

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

noexcept

Expose parent liveliness getter method.

Returns: LivelinessQosPolicy

◆ liveliness() [2/3]

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

deletenoexcept

Expose parent liveliness getter method.

Returns: LivelinessQosPolicy

◆ liveliness() [3/3]

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

noexcept

Expose parent liveliness getter method.

Returns: LivelinessQosPolicy

◆ operator=() [1/2]

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

defaultnoexcept

Assignment operator.

Returns: EndpointQos

◆ operator=() [2/2]

EndpointQos& eprosima::safedds::dds::EndpointQos::operator= ( EndpointQos && other )

defaultnoexcept

Move assignment operator.

Parameters

other EndpointQos to move.

Returns: EndpointQos

◆ ownership() [1/3]

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

noexcept

Expose parent ownership getter method.

Returns: OwnershipQosPolicy

◆ ownership() [2/3]

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

deletenoexcept

Expose parent ownership getter method.

Returns: OwnershipQosPolicy

◆ ownership() [3/3]

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

noexcept

Expose parent ownership getter method.

Returns: OwnershipQosPolicy

◆ partition() [1/3]

PartitionQosPolicy& eprosima::safedds::dds::EndpointQos::partition ( ) &

noexcept

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

Returns: PartitionQosPolicy

◆ partition() [2/3]

const PartitionQosPolicy& eprosima::safedds::dds::EndpointQos::partition ( ) const &&

deletenoexcept

Deleted const getter for PartitionQosPolicy on rvalue objects.

◆ partition() [3/3]

const PartitionQosPolicy& eprosima::safedds::dds::EndpointQos::partition ( ) const &

noexcept

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

Returns: PartitionQosPolicy

◆ presentation() [1/3]

PresentationQosPolicy& eprosima::safedds::dds::EndpointQos::presentation ( ) &

noexcept

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

Returns: PresentationQosPolicy

◆ presentation() [2/3]

const PresentationQosPolicy& eprosima::safedds::dds::EndpointQos::presentation ( ) const &&

deletenoexcept

Deleted const getter for PresentationQosPolicy on rvalue objects.

◆ presentation() [3/3]

const PresentationQosPolicy& eprosima::safedds::dds::EndpointQos::presentation ( ) const &

noexcept

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

Returns: PresentationQosPolicy

◆ reliability() [1/3]

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

noexcept

Expose parent reliability getter method.

Returns: ReliabilityQosPolicy

◆ reliability() [2/3]

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

deletenoexcept

Expose parent reliability getter method.

Returns: ReliabilityQosPolicy

◆ reliability() [3/3]

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

noexcept

Expose parent reliability getter method.

Returns: ReliabilityQosPolicy

◆ representation() [1/3]

DataRepresentationQosPolicy& eprosima::safedds::dds::EndpointQos::representation ( ) &

noexcept

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

Returns: DataRepresentationQosPolicy

◆ representation() [2/3]

const DataRepresentationQosPolicy& eprosima::safedds::dds::EndpointQos::representation ( ) const &&

deletenoexcept

Deleted const getter for DataRepresentationQosPolicy on rvalue objects.

◆ representation() [3/3]

const DataRepresentationQosPolicy& eprosima::safedds::dds::EndpointQos::representation ( ) const &

noexcept

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

Returns: DataRepresentationQosPolicy

◆ resource_limits() [1/3]

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

noexcept

Expose parent resource_limits getter method.

Returns: ResourceLimitsQosPolicy

◆ resource_limits() [2/3]

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

deletenoexcept

Expose parent resource_limits getter method.

Returns: ResourceLimitsQosPolicy

◆ resource_limits() [3/3]

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

noexcept

Expose parent resource_limits getter method.

Returns: ResourceLimitsQosPolicy

◆ user_data() [1/3]

UserDataQosPolicy& eprosima::safedds::dds::EndpointQos::user_data ( ) &

noexcept

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

Returns: UserDataQosPolicy

◆ user_data() [2/3]

const UserDataQosPolicy& eprosima::safedds::dds::EndpointQos::user_data ( ) const &&

deletenoexcept

Deleted const getter for UserDataQosPolicy on rvalue objects.

◆ user_data() [3/3]

const UserDataQosPolicy& eprosima::safedds::dds::EndpointQos::user_data ( ) const &

noexcept

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

Returns: UserDataQosPolicy

Member Data Documentation

◆ partition_

PartitionQosPolicy eprosima::safedds::dds::EndpointQos::partition_

protected

Partition QoS policy.

◆ presentation_

PresentationQosPolicy eprosima::safedds::dds::EndpointQos::presentation_

protected

Presentation QoS policy.

◆ representation_

DataRepresentationQosPolicy eprosima::safedds::dds::EndpointQos::representation_

protected

Data representation QoS policy.

◆ user_data_

UserDataQosPolicy eprosima::safedds::dds::EndpointQos::user_data_

protected

User data QoS policy.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EndpointQos() [1/3]

◆ ~EndpointQos()

◆ EndpointQos() [2/3]

◆ EndpointQos() [3/3]

Member Function Documentation

◆ common_qos() [1/3]

◆ common_qos() [2/3]

◆ common_qos() [3/3]

◆ 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]

◆ partition() [1/3]

◆ partition() [2/3]

◆ partition() [3/3]

◆ presentation() [1/3]

◆ presentation() [2/3]

◆ presentation() [3/3]

◆ reliability() [1/3]

◆ reliability() [2/3]

◆ reliability() [3/3]

◆ representation() [1/3]

◆ representation() [2/3]

◆ representation() [3/3]

◆ resource_limits() [1/3]

◆ resource_limits() [2/3]

◆ resource_limits() [3/3]

◆ user_data() [1/3]

◆ user_data() [2/3]

◆ user_data() [3/3]

Member Data Documentation

◆ partition_

◆ presentation_

◆ representation_

◆ user_data_