QoS policies supported by a com.rti.dds.topic.Topic entity. More...

Inheritance diagram for TopicQos:

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

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

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

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

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

Public Attributes
final TopicDataQosPolicy	topic_data
	Topic data policy, TOPIC_DATA. More...

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

final DurabilityServiceQosPolicy	durability_service
	DurabilityService policy, DURABILITY_SERVICE. 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 TransportPriorityQosPolicy	transport_priority
	Transport priority policy, TRANSPORT_PRIORITY. More...

final LifespanQosPolicy	lifespan
	Lifespan policy, LIFESPAN. More...

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

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

Detailed Description

QoS policies supported by a com.rti.dds.topic.Topic entity.

You must set certain members in a consistent manner:

length of com.rti.dds.topic.TopicQos.topic_data .value <= com.rti.dds.domain.DomainParticipantQos.resource_limits .topic_data_max_length

If any of the above are not true, com.rti.dds.topic.Topic.set_qos, com.rti.dds.topic.Topic.set_qos_with_profile and com.rti.dds.domain.DomainParticipant.set_default_topic_qos will fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY and com.rti.dds.domain.DomainParticipant.create_topic will return NULL.

Entity:: com.rti.dds.topic.Topic

See also: QoS Policies allowed ranges within each Qos.

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

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

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

Returns: The string representation of the Qos.

References TopicQos.toString().

Referenced by TopicQos.toString().

◆ toString() [2/4]

String toString	(	TopicQos	baseQos,
		QosPrintFormat	format
	)

Obtains a string representation of a TopicQos 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.TOPIC_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.TOPIC_QOS_PRINT_ALL.

◆ toString() [3/4]

String toString ( QosPrintFormat format )

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

◆ toString() [4/4]

String toString ( TopicQos baseQos )

Obtains a string representation of a TopicQos 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.TOPIC_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.