QoS policies supported by a com.rti.dds.subscription.DataReader entity. More...

Inheritance diagram for DataReaderQos:

Public Member Functions
String	toString ()
	Overrides the builtin Object.toString method. More...

String	toString (DataReaderQos baseQos, QosPrintFormat format)
	Obtains a string representation of a DataReaderQos object. More...

String	toString (QosPrintFormat format)
	Obtains a string representation of a DataReaderQos object. More...

String	toString (DataReaderQos baseQos)
	Obtains a string representation of a DataReaderQos object. More...

Public Member Functions inherited from Qos
final boolean	equals (Object other)

Public Attributes
final DurabilityQosPolicy	durability
	Durability policy, DURABILITY. More...

final DeadlineQosPolicy	deadline
	Deadline policy, DEADLINE. More...

final LatencyBudgetQosPolicy	latency_budget
	Latency budget policy, LATENCY_BUDGET. More...

final LivelinessQosPolicy	liveliness
	Liveliness policy, LIVELINESS. More...

final ReliabilityQosPolicy	reliability
	Reliability policy, RELIABILITY. More...

final DestinationOrderQosPolicy	destination_order
	Destination order policy, DESTINATION_ORDER. More...

final HistoryQosPolicy	history
	History policy, HISTORY. More...

final ResourceLimitsQosPolicy	resource_limits
	Resource limits policy, RESOURCE_LIMITS. More...

final UserDataQosPolicy	user_data
	User data policy, USER_DATA. More...

final OwnershipQosPolicy	ownership
	Ownership policy, OWNERSHIP. More...

final TimeBasedFilterQosPolicy	time_based_filter
	Time-based filter policy, TIME_BASED_FILTER. More...

final ReaderDataLifecycleQosPolicy	reader_data_lifecycle
	Reader data lifecycle policy, READER_DATA_LIFECYCLE. More...

final DataReaderResourceLimitsQosPolicy	reader_resource_limits
	<<extension>> com.rti.dds.subscription.DataReader resource limits policy, DATA_READER_RESOURCE_LIMITS. This policy is an extension to the DDS standard. More...

final DataReaderProtocolQosPolicy	protocol
	<<extension>> com.rti.dds.subscription.DataReader protocol policy, DATA_READER_PROTOCOL More...

final TransportSelectionQosPolicy	transport_selection
	<<extension>> Transport selection policy, TRANSPORT_SELECTION. More...

final TransportUnicastQosPolicy	unicast
	<<extension>> Unicast transport policy, TRANSPORT_UNICAST. More...

final TransportMulticastQosPolicy	multicast
	<<extension>> Multicast transport policy, TRANSPORT_MULTICAST. More...

final PropertyQosPolicy	property
	<<extension>> Property policy, PROPERTY. More...

final DataTagQosPolicy	data_tags
	DataTag policy, DATA_TAG. More...

final ServiceQosPolicy	service
	<<extension>> Service policy, SERVICE. More...

final AvailabilityQosPolicy	availability
	<<extension>> Availability policy, AVAILABILITY. More...

final EntityNameQosPolicy	subscription_name
	<<extension>> EntityName policy, ENTITY_NAME. More...

final TransportPriorityQosPolicy	transport_priority
	Transport priority policy, TRANSPORT_PRIORITY. More...

final TypeConsistencyEnforcementQosPolicy	type_consistency
	Type consistency enforcement policy, TYPE_CONSISTENCY_ENFORCEMENT. More...

final DataRepresentationQosPolicy	representation
	Data representation policy, DATA_REPRESENTATION. More...

final TypeSupportQosPolicy	type_support
	<<extension>> type support data, TYPESUPPORT. More...

Detailed Description

QoS policies supported by a com.rti.dds.subscription.DataReader entity.

You must set certain members in a consistent manner:

com.rti.dds.subscription.DataReaderQos.deadline .period >= com.rti.dds.subscription.DataReaderQos.time_based_filter .minimum_separation

com.rti.dds.subscription.DataReaderQos.history .depth <= com.rti.dds.subscription.DataReaderQos.resource_limits .max_samples_per_instance

com.rti.dds.subscription.DataReaderQos.resource_limits .max_samples_per_instance <= com.rti.dds.subscription.DataReaderQos.resource_limits .max_samples com.rti.dds.subscription.DataReaderQos.resource_limits .initial_samples <= com.rti.dds.subscription.DataReaderQos.resource_limits .max_samples

com.rti.dds.subscription.DataReaderQos.resource_limits .initial_instances <= com.rti.dds.subscription.DataReaderQos.resource_limits .max_instances

com.rti.dds.subscription.DataReaderQos.reader_resource_limits .initial_remote_writers_per_instance <= com.rti.dds.subscription.DataReaderQos.reader_resource_limits .max_remote_writers_per_instance

com.rti.dds.subscription.DataReaderQos.reader_resource_limits .initial_infos <= com.rti.dds.subscription.DataReaderQos.reader_resource_limits .max_infos

com.rti.dds.subscription.DataReaderQos.reader_resource_limits .max_remote_writers_per_instance <= com.rti.dds.subscription.DataReaderQos.reader_resource_limits .max_remote_writers

com.rti.dds.subscription.DataReaderQos.reader_resource_limits .max_samples_per_remote_writer <= com.rti.dds.subscription.DataReaderQos.resource_limits .max_samples

length of com.rti.dds.subscription.DataReaderQos.user_data .value <= com.rti.dds.domain.DomainParticipantQos.resource_limits .reader_user_data_max_length

If any of the above are not true, com.rti.dds.subscription.DataReader.set_qos and com.rti.dds.subscription.DataReader.set_qos_with_profile will fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY and com.rti.dds.subscription.Subscriber.create_datareader will return NULL.

Member Function Documentation

◆ toString() [1/4]

String toString ( )

Overrides the builtin Object.toString method.

The various toString() overloads allow formatting the output and printing only the differences with respect to another DataReaderQos object.

DataReaderQos qos = new DataReaderQos();
String theString = new String();
// The most basic version of the API simply overrides the builtin
// Object.toString method. Only the differences with respect to the
// documented default are printed to the string. The string is formatted
// according to the default values for QosPrintFormat.
theString = qos.toString();
// This overload allows us to specify a base profile. Only the differences
// with respect to this base profile are printed to the string. If the two
// Qos objects are equal, the resultant string will be empty.
DataReaderQos baseQos = new DataReaderQos(); // ...;
theString = qos.toString(baseQos);
// It is also possible to supply a custom format at this point
QosPrintFormat printFormat = new QosPrintFormat(); // ...;
theString = qos.toString(baseQos, format);
// The sentinel value DATAREADER_QOS_PRINT_ALL can be used as
// the base in order to print the entire qos object
theString = qos.toString(DATAREADER_QOS_PRINT_ALL);

This overload uses the default print format and only prints the differences between the supplied DataReaderQos and the documented default.

Returns: The string representation of the Qos.

Referenced by DataReaderQos.toString().

◆ toString() [2/4]

String toString	(	DataReaderQos	baseQos,
		QosPrintFormat	format
	)

Obtains a string representation of a DataReaderQos object.

Parameters

format	The print format used to format the output.
baseQos	Only the differences between baseQos and the Qos object are included in the output string. If you want to print everything within the Qos, use the com.rti.dds.subscription.Subscriber.DATAREADER_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the qos and the supplied baseQos. The output string is formatted using the supplied com.rti.dds.infrastructure.QosPrintFormat.

Returns: The string representation of the Qos.

References Subscriber.DATAREADER_QOS_PRINT_ALL.

◆ toString() [3/4]

String toString ( QosPrintFormat format )

Obtains a string representation of a DataReaderQos object.

Parameters

format The print format used to format the output.

This overload prints the differences between the qos and the documented. default. The output string is formatted using the supplied com.rti.dds.infrastructure.QosPrintFormat.

Returns: The string representation of the Qos.

References DataReaderQos.toString().

◆ toString() [4/4]

String toString ( DataReaderQos baseQos )

Obtains a string representation of a DataReaderQos object.

Parameters

baseQos Only the differences between baseQos and the Qos object are included in the output string. If you want to print everything within the Qos, use the com.rti.dds.subscription.Subscriber.DATAREADER_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the qos and the supplied baseQos. The output string is formatted using the default value for com.rti.dds.infrastructure.QosPrintFormat.