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

#include <DataReaderQos.hpp>

Public Member Functions
	DataReaderQos () noexcept
	Constructor. More...

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

DataReaderWireProtocolQosPolicy &	wire_protocol_qos () &noexcept
	Getter for DataReaderWireProtocolQosPolicy. Can only be used on lvalue objects. More...

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

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

const DataReaderWireProtocolQosPolicy &	wire_protocol_qos () const &&noexcept=delete
	Deleted const getter for DataReaderWireProtocolQosPolicy on rvalue objects. More...

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

TimeBasedFilterQosPolicy &	time_based_filter () &noexcept
	Time based filter getter. Can only be used on lvalue objects. More...

const TimeBasedFilterQosPolicy &	time_based_filter () const &&noexcept=delete
	Deleted const getter for TimeBasedFilterQosPolicy on rvalue objects. More...

const TimeBasedFilterQosPolicy &	time_based_filter () const &noexcept
	Const Time based filter getter. Can only be used on lvalue objects. More...

ReaderDataLifecycleQosPolicy &	reader_data_lifecycle () &noexcept
	Reader data lifecycle getter. Can only be used on lvalue objects. More...

const ReaderDataLifecycleQosPolicy &	reader_data_lifecycle () const &&noexcept=delete
	Deleted const getter for ReaderDataLifecycleQosPolicy on rvalue objects. More...

const ReaderDataLifecycleQosPolicy &	reader_data_lifecycle () const &noexcept
	Const Reader data lifecycle getter. Can only be used on lvalue objects. More...

EndpointQos &	endpoint_qos () &noexcept
	Get EndpointQos. Can only be used on lvalue objects. More...

const EndpointQos &	endpoint_qos () const &&noexcept=delete
	Deleted const getter for EndpointQos on rvalue objects. More...

const EndpointQos &	endpoint_qos () const &noexcept
	Get const EndpointQos. 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...

PartitionQosPolicy &	partition () &noexcept
	Expose parent partition getter method. More...

const PartitionQosPolicy &	partition () const &&noexcept=delete
	Expose parent partition getter method. More...

const PartitionQosPolicy &	partition () const &noexcept
	Expose parent partition getter method. More...

PresentationQosPolicy &	presentation () &noexcept
	Expose parent presentation getter method. More...

const PresentationQosPolicy &	presentation () const &&noexcept=delete
	Expose parent presentation getter method. More...

const PresentationQosPolicy &	presentation () const &noexcept
	Expose parent presentation getter method. More...

UserDataQosPolicy &	user_data () &noexcept
	Expose parent user_data getter method. More...

const UserDataQosPolicy &	user_data () const &&noexcept=delete
	Expose parent user_data getter method. More...

const UserDataQosPolicy &	user_data () const &noexcept
	Expose parent user_data getter method. More...

DataRepresentationQosPolicy &	representation () &noexcept
	Expose parent representation getter method. More...

const DataRepresentationQosPolicy &	representation () const &&noexcept=delete
	Expose parent representation getter method. More...

const DataRepresentationQosPolicy &	representation () const &noexcept
	Expose parent representation getter method. More...

Static Public Member Functions
static DataReaderQos	from_data (const discovery::SubscriptionInfo &subscription_info) noexcept
	Creates a DataReaderQos from a SubscriptionInfo. More...

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

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

Detailed Description

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

Note: In all cases, DataReaderQos will follow the target TopicQoS configuration.

Constructor & Destructor Documentation

◆ DataReaderQos()

eprosima::safedds::dds::DataReaderQos::DataReaderQos ( )

explicitnoexcept

Constructor.

Member Function Documentation

◆ allocations() [1/3]

DataReaderAllocationsQosPolicy& eprosima::safedds::dds::DataReaderQos::allocations ( ) &

noexcept

Allocations getter. Can only be used on lvalue objects.

Returns: DataReaderAllocationsQosPolicy.

◆ allocations() [2/3]

const DataReaderAllocationsQosPolicy& eprosima::safedds::dds::DataReaderQos::allocations ( ) const &&

deletenoexcept

Deleted const getter for DataReaderAllocationsQosPolicy on rvalue objects.

◆ allocations() [3/3]

const DataReaderAllocationsQosPolicy& eprosima::safedds::dds::DataReaderQos::allocations ( ) const &

noexcept

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

Returns: DataReaderAllocationsQosPolicy.

◆ endpoint_qos() [1/3]

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

noexcept

Get EndpointQos. Can only be used on lvalue objects.

Returns: EndpointQos&

◆ endpoint_qos() [2/3]

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

deletenoexcept

Deleted const getter for EndpointQos on rvalue objects.

◆ endpoint_qos() [3/3]

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

noexcept

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

Returns: EndpointQos&

◆ from_data()

static DataReaderQos eprosima::safedds::dds::DataReaderQos::from_data ( const discovery::SubscriptionInfo & subscription_info )

staticnoexcept

Creates a DataReaderQos from a SubscriptionInfo.

Parameters

subscription_info SubscriptionInfo to be used.

Returns: DataReaderQos.

◆ is_consistent()

ReturnCode eprosima::safedds::dds::DataReaderQos::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::DataReaderQos::is_supported ( ) const

overridevirtualnoexcept

Check all QoS policies are supported.

Returns: ReturnCode.

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

◆ partition() [1/3]

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

noexcept

Expose parent partition getter method.

Returns: PartitionQosPolicy

◆ partition() [2/3]

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

deletenoexcept

Expose parent partition getter method.

Returns: PartitionQosPolicy

◆ partition() [3/3]

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

noexcept

Expose parent partition getter method.

Returns: PartitionQosPolicy

◆ presentation() [1/3]

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

noexcept

Expose parent presentation getter method.

Returns: PresentationQosPolicy

◆ presentation() [2/3]

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

deletenoexcept

Expose parent presentation getter method.

Returns: PresentationQosPolicy

◆ presentation() [3/3]

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

noexcept

Expose parent presentation getter method.

Returns: PresentationQosPolicy

◆ reader_data_lifecycle() [1/3]

ReaderDataLifecycleQosPolicy& eprosima::safedds::dds::DataReaderQos::reader_data_lifecycle ( ) &

noexcept

Reader data lifecycle getter. Can only be used on lvalue objects.

Returns: ReaderDataLifecycleQosPolicy&

◆ reader_data_lifecycle() [2/3]

const ReaderDataLifecycleQosPolicy& eprosima::safedds::dds::DataReaderQos::reader_data_lifecycle ( ) const &&

deletenoexcept

Deleted const getter for ReaderDataLifecycleQosPolicy on rvalue objects.

◆ reader_data_lifecycle() [3/3]

const ReaderDataLifecycleQosPolicy& eprosima::safedds::dds::DataReaderQos::reader_data_lifecycle ( ) const &

noexcept

Const Reader data lifecycle getter. Can only be used on lvalue objects.

Returns: ReaderDataLifecycleQosPolicy&

◆ representation() [1/3]

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

noexcept

Expose parent representation getter method.

Returns: DataRepresentationQosPolicy

◆ representation() [2/3]

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

deletenoexcept

Expose parent representation getter method.

Returns: DataRepresentationQosPolicy

◆ representation() [3/3]

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

noexcept

Expose parent representation getter method.

Returns: DataRepresentationQosPolicy

◆ time_based_filter() [1/3]

TimeBasedFilterQosPolicy& eprosima::safedds::dds::DataReaderQos::time_based_filter ( ) &

noexcept

Time based filter getter. Can only be used on lvalue objects.

Returns: TimeBasedFilterQosPolicy&

◆ time_based_filter() [2/3]

const TimeBasedFilterQosPolicy& eprosima::safedds::dds::DataReaderQos::time_based_filter ( ) const &&

deletenoexcept

Deleted const getter for TimeBasedFilterQosPolicy on rvalue objects.

◆ time_based_filter() [3/3]

const TimeBasedFilterQosPolicy& eprosima::safedds::dds::DataReaderQos::time_based_filter ( ) const &

noexcept

Const Time based filter getter. Can only be used on lvalue objects.

Returns: TimeBasedFilterQosPolicy&

◆ user_data() [1/3]

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

noexcept

Expose parent user_data getter method.

Returns: UserDataQosPolicy

◆ user_data() [2/3]

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

deletenoexcept

Expose parent user_data getter method.

Returns: UserDataQosPolicy

◆ user_data() [3/3]

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

noexcept

Expose parent user_data getter method.

Returns: UserDataQosPolicy

◆ wire_protocol_qos() [1/3]

DataReaderWireProtocolQosPolicy& eprosima::safedds::dds::DataReaderQos::wire_protocol_qos ( ) &

noexcept

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

Returns: DataReaderWireProtocolQosPolicy

◆ wire_protocol_qos() [2/3]

const DataReaderWireProtocolQosPolicy& eprosima::safedds::dds::DataReaderQos::wire_protocol_qos ( ) const &&

deletenoexcept

Deleted const getter for DataReaderWireProtocolQosPolicy on rvalue objects.

◆ wire_protocol_qos() [3/3]

const DataReaderWireProtocolQosPolicy& eprosima::safedds::dds::DataReaderQos::wire_protocol_qos ( ) const &

noexcept

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

Returns: DataReaderWireProtocolQosPolicy

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

build/docs/user_manual/v2.0.0/tmp/include/safedds/dds/qos/DataReaderQos.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DataReaderQos()

Member Function Documentation

◆ allocations() [1/3]

◆ allocations() [2/3]

◆ allocations() [3/3]

◆ endpoint_qos() [1/3]

◆ endpoint_qos() [2/3]

◆ endpoint_qos() [3/3]

◆ from_data()

◆ is_consistent()

◆ is_supported()

◆ partition() [1/3]

◆ partition() [2/3]

◆ partition() [3/3]

◆ presentation() [1/3]

◆ presentation() [2/3]

◆ presentation() [3/3]

◆ reader_data_lifecycle() [1/3]

◆ reader_data_lifecycle() [2/3]

◆ reader_data_lifecycle() [3/3]

◆ representation() [1/3]

◆ representation() [2/3]

◆ representation() [3/3]

◆ time_based_filter() [1/3]

◆ time_based_filter() [2/3]

◆ time_based_filter() [3/3]

◆ user_data() [1/3]

◆ user_data() [2/3]

◆ user_data() [3/3]

◆ wire_protocol_qos() [1/3]

◆ wire_protocol_qos() [2/3]

◆ wire_protocol_qos() [3/3]