QoS policies supported by a com.rti.dds.domain.DomainParticipant entity. More...

Inheritance diagram for DomainParticipantQos:

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

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

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

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

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

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

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

final WireProtocolQosPolicy	wire_protocol
	<<extension>> Wire Protocol policy, WIRE_PROTOCOL. More...

final TransportBuiltinQosPolicy	transport_builtin
	<<extension>> Transport Builtin policy, TRANSPORT_BUILTIN. More...

final TransportUnicastQosPolicy	default_unicast
	<<extension>> Default Unicast Transport policy, TRANSPORT_UNICAST. More...

final DiscoveryQosPolicy	discovery
	<<extension>> Discovery policy, DISCOVERY. More...

final DomainParticipantResourceLimitsQosPolicy	resource_limits
	<<extension>> Domain participant resource limits policy, DOMAIN_PARTICIPANT_RESOURCE_LIMITS. More...

final EventQosPolicy	event
	<<extension>> Event policy, EVENT. More...

final ReceiverPoolQosPolicy	receiver_pool
	<<extension>> Receiver pool policy, RECEIVER_POOL. More...

final DatabaseQosPolicy	database
	<<extension>> Database policy, DATABASE. More...

final DiscoveryConfigQosPolicy	discovery_config
	<<extension>> Discovery config policy, DISCOVERY_CONFIG. More...

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

final EntityNameQosPolicy	participant_name
	<<extension>> The participant name. ENTITY_NAME More...

final ServiceQosPolicy	service
	<<extension>> The service qos policy. SERVICE More...

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

final TransportMulticastMappingQosPolicy	multicast_mapping
	<<extension>> The multicast mapping policy. TRANSPORT_MULTICAST_MAPPING More...

final PartitionQosPolicy	partition
	<<extension>> The partition qos policy. PARTITION More...

Detailed Description

QoS policies supported by a com.rti.dds.domain.DomainParticipant entity.

Certain members must be set in a consistent manner:

Length of com.rti.dds.domain.DomainParticipantQos.user_data .value <= com.rti.dds.domain.DomainParticipantQos.resource_limits .participant_user_data_max_length

For com.rti.dds.domain.DomainParticipantQos.discovery_config .publication_writer
high_watermark <= com.rti.dds.domain.DomainParticipantQos.resource_limits .local_writer_allocation .max_count heartbeats_per_max_samples <= com.rti.dds.domain.DomainParticipantQos.resource_limits .local_writer_allocation.max_count

For com.rti.dds.domain.DomainParticipantQos.discovery_config .suscription_writer
high_watermark <= com.rti.dds.domain.DomainParticipantQos.resource_limits .local_reader_allocation.max_count heartbeats_per_max_samples <= com.rti.dds.domain.DomainParticipantQos.resource_limits .local_reader_allocation.max_count

If any of the above are not true, com.rti.dds.domain.DomainParticipant.set_qos and com.rti.dds.domain.DomainParticipant.set_qos_with_profile and com.rti.dds.domain.DomainParticipantFactory.set_default_participant_qos will fail with com.rti.dds.infrastructure.RETCODE_INCONSISTENT_POLICY, and com.rti.dds.domain.DomainParticipantFactory.create_participant will fail.

Entity:: com.rti.dds.domain.DomainParticipant

See also: QoS Policies and allowed ranges within each Qos.; NDDS_DISCOVERY_PEERS

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

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

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

Returns: The string representation of the Qos.

References DomainParticipantQos.toString().

Referenced by DomainParticipantQos.toString().

◆ toString() [2/4]

String toString	(	DomainParticipantQos	baseQos,
		QosPrintFormat	format
	)

Obtains a string representation of a DomainParticipantQos 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.DOMAINPARTICIPANT_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.DOMAINPARTICIPANT_QOS_PRINT_ALL.

◆ toString() [3/4]

String toString ( QosPrintFormat format )

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

◆ toString() [4/4]

String toString ( DomainParticipantQos baseQos )

Obtains a string representation of a DomainParticipantQos 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.DOMAINPARTICIPANT_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.