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

Inheritance diagram for SubscriberQos:

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

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

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

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

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

Public Attributes
final PresentationQosPolicy	presentation
	Presentation policy, PRESENTATION. More...

final PartitionQosPolicy	partition
	Partition policy, PARTITION. More...

final GroupDataQosPolicy	group_data
	Group data policy, GROUP_DATA. More...

final EntityFactoryQosPolicy	entity_factory
	Entity factory policy, ENTITY_FACTORY. More...

final ExclusiveAreaQosPolicy	exclusive_area
	<<extension>> Exclusive area for the subscriber and all entities that are created by the subscriber. More...

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

Detailed Description

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

You must set certain members in a consistent manner:

length of com.rti.dds.infrastructure.GroupDataQosPolicy.value <= com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.subscriber_group_data_max_length

length of com.rti.dds.infrastructure.PartitionQosPolicy.name <= com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.max_partitions

combined number of characters (including terminating 0) in com.rti.dds.infrastructure.PartitionQosPolicy.name <= com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.max_partition_cumulative_characters

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

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.

SubscriberQos qos = new SubscriberQos();
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.
SubscriberQos baseQos = new SubscriberQos(); // ...;
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 SUBSCRIBER_QOS_PRINT_ALL can be used as
// the base in order to print the entire qos object
theString = qos.toString(SUBSCRIBER_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.

References SubscriberQos.toString().

Referenced by SubscriberQos.toString().

◆ toString() [2/4]

String toString	(	SubscriberQos	baseQos,
		QosPrintFormat	format
	)

Obtains a string representation of a SubscriberQos 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.domain.DomainParticipant.SUBSCRIBER_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 DomainParticipant.SUBSCRIBER_QOS_PRINT_ALL.

◆ toString() [3/4]

String toString ( QosPrintFormat format )

Obtains a string representation of a SubscriberQos 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 SubscriberQos.toString().

◆ toString() [4/4]

String toString ( SubscriberQos 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.domain.DomainParticipant.SUBSCRIBER_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.