Class to store and manage a dds::Topic QoS configuration. More...

#include <TopicQos.hpp>

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

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

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

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

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

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

TopicAllocationsQosPolicy &	allocations () &noexcept
	Allocations getter. Can only be used on lvalue objects. More...

const TopicAllocationsQosPolicy &	allocations () const &&noexcept=delete
	Deleted const getter for TopicAllocationsQosPolicy on rvalue objects. More...

const TopicAllocationsQosPolicy &	allocations () const &noexcept
	Const Allocations getter. Can only be used on lvalue objects. More...

TopicDataQosPolicy &	topic_data () &noexcept
	TopicData getter. Can only be used on lvalue objects. More...

const TopicDataQosPolicy &	topic_data () const &&noexcept=delete
	Deleted const getter for TopicDataQosPolicy on rvalue objects. More...

const TopicDataQosPolicy &	topic_data () const &noexcept
	Const TopicData getter. Can only be used on lvalue objects. More...

DurabilityServiceQosPolicy &	durability_service () &noexcept
	DurabilityServiceQosPolicy getter. Can only be used on lvalue objects. More...

const DurabilityServiceQosPolicy &	durability_service () const &&noexcept=delete
	Deleted const getter for DurabilityServiceQosPolicy on rvalue objects. More...

const DurabilityServiceQosPolicy &	durability_service () const &noexcept
	Const DurabilityServiceQosPolicy getter. Can only be used on lvalue objects. More...

TransportPriorityQosPolicy &	transport_priority () &noexcept
	TransportPriority getter. Can only be used on lvalue objects. More...

const TransportPriorityQosPolicy &	transport_priority () const &&noexcept=delete
	Deleted const getter for TransportPriorityQosPolicy on rvalue objects. More...

const TransportPriorityQosPolicy &	transport_priority () const &noexcept
	Const TransportPriority getter. Can only be used on lvalue objects. More...

LifespanQosPolicy &	lifespan () &noexcept
	Lifespan getter. Can only be used on lvalue objects. More...

const LifespanQosPolicy &	lifespan () const &&noexcept=delete
	Deleted const getter for LifespanQosPolicy on rvalue objects. More...

const LifespanQosPolicy &	lifespan () const &noexcept
	Const Lifespan getter. Can only be used on lvalue objects. More...

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

virtual ReturnCode	is_consistent () const noexcept
	Expose parent is_consistent method. 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...

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...

virtual ReturnCode	is_consistent () const noexcept
	Check if configured Qos values are consistent. 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...

Detailed Description

Class to store and manage a dds::Topic QoS configuration.

Note: In all cases, Topic QoS are honored by DataWriter QoS and DataReader QoS.

Constructor & Destructor Documentation

◆ TopicQos() [1/3]

eprosima::safedds::dds::TopicQos::TopicQos ( )

explicitdefaultnoexcept

Default constructor.

◆ ~TopicQos()

eprosima::safedds::dds::TopicQos::~TopicQos ( )

overridedefaultnoexcept

Destructor.

◆ TopicQos() [2/3]

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

defaultnoexcept

Copy constructor.

◆ TopicQos() [3/3]

eprosima::safedds::dds::TopicQos::TopicQos ( TopicQos && )

defaultnoexcept

Move constructor.

Member Function Documentation

◆ allocations() [1/3]

TopicAllocationsQosPolicy& eprosima::safedds::dds::TopicQos::allocations ( ) &

noexcept

Allocations getter. Can only be used on lvalue objects.

Returns: TopicAllocationsQosPolicy.

◆ allocations() [2/3]

const TopicAllocationsQosPolicy& eprosima::safedds::dds::TopicQos::allocations ( ) const &&

deletenoexcept

Deleted const getter for TopicAllocationsQosPolicy on rvalue objects.

◆ allocations() [3/3]

const TopicAllocationsQosPolicy& eprosima::safedds::dds::TopicQos::allocations ( ) const &

noexcept

Const Allocations getter. Can only be used on lvalue objects.

Returns: TopicAllocationsQosPolicy.

◆ 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

◆ durability_service() [1/3]

DurabilityServiceQosPolicy& eprosima::safedds::dds::TopicQos::durability_service ( ) &

noexcept

DurabilityServiceQosPolicy getter. Can only be used on lvalue objects.

Returns: DurabilityServiceQosPolicy

◆ durability_service() [2/3]

const DurabilityServiceQosPolicy& eprosima::safedds::dds::TopicQos::durability_service ( ) const &&

deletenoexcept

Deleted const getter for DurabilityServiceQosPolicy on rvalue objects.

◆ durability_service() [3/3]

const DurabilityServiceQosPolicy& eprosima::safedds::dds::TopicQos::durability_service ( ) const &

noexcept

Const DurabilityServiceQosPolicy getter. Can only be used on lvalue objects.

Returns: DurabilityServiceQosPolicy

◆ 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()

virtual ReturnCode eprosima::safedds::dds::CommonQos::is_consistent

noexcept

Expose parent is_consistent method.

Returns: bool

◆ is_supported()

ReturnCode eprosima::safedds::dds::TopicQos::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

◆ lifespan() [1/3]

LifespanQosPolicy& eprosima::safedds::dds::TopicQos::lifespan ( ) &

noexcept

Lifespan getter. Can only be used on lvalue objects.

Returns: LifespanQosPolicy

◆ lifespan() [2/3]

const LifespanQosPolicy& eprosima::safedds::dds::TopicQos::lifespan ( ) const &&

deletenoexcept

Deleted const getter for LifespanQosPolicy on rvalue objects.

◆ lifespan() [3/3]

const LifespanQosPolicy& eprosima::safedds::dds::TopicQos::lifespan ( ) const &

noexcept

Const Lifespan getter. Can only be used on lvalue objects.

Returns: LifespanQosPolicy

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

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

defaultnoexcept

Assignment operator.

Returns: TopicQos

◆ operator=() [2/2]

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

defaultnoexcept

Move assignment operator.

Parameters

◆ 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

◆ 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

◆ 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

◆ topic_data() [1/3]

TopicDataQosPolicy& eprosima::safedds::dds::TopicQos::topic_data ( ) &

noexcept

TopicData getter. Can only be used on lvalue objects.

Returns: TopicDataQosPolicy.

◆ topic_data() [2/3]

const TopicDataQosPolicy& eprosima::safedds::dds::TopicQos::topic_data ( ) const &&

deletenoexcept

Deleted const getter for TopicDataQosPolicy on rvalue objects.

◆ topic_data() [3/3]

const TopicDataQosPolicy& eprosima::safedds::dds::TopicQos::topic_data ( ) const &

noexcept

Const TopicData getter. Can only be used on lvalue objects.

Returns: TopicDataQosPolicy.

◆ transport_priority() [1/3]

TransportPriorityQosPolicy& eprosima::safedds::dds::TopicQos::transport_priority ( ) &

noexcept

TransportPriority getter. Can only be used on lvalue objects.

Returns: TransportPriorityQosPolicy

◆ transport_priority() [2/3]

const TransportPriorityQosPolicy& eprosima::safedds::dds::TopicQos::transport_priority ( ) const &&

deletenoexcept

Deleted const getter for TransportPriorityQosPolicy on rvalue objects.

◆ transport_priority() [3/3]

const TransportPriorityQosPolicy& eprosima::safedds::dds::TopicQos::transport_priority ( ) const &

noexcept

Const TransportPriority getter. Can only be used on lvalue objects.

Returns: TransportPriorityQosPolicy

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TopicQos() [1/3]

◆ ~TopicQos()

◆ TopicQos() [2/3]

◆ TopicQos() [3/3]

Member Function Documentation

◆ allocations() [1/3]

◆ allocations() [2/3]

◆ allocations() [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]

◆ durability_service() [1/3]

◆ durability_service() [2/3]

◆ durability_service() [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]

◆ lifespan() [1/3]

◆ lifespan() [2/3]

◆ lifespan() [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]

◆ topic_data() [1/3]

◆ topic_data() [2/3]

◆ topic_data() [3/3]

◆ transport_priority() [1/3]

◆ transport_priority() [2/3]

◆ transport_priority() [3/3]