RTI Connext Java API  Version 6.1.1
DomainParticipantFactoryQos Class Reference

QoS policies supported by a com.rti.dds.domain.DomainParticipantFactory. More...

Inheritance diagram for DomainParticipantFactoryQos:
Qos

Public Member Functions

String toString ()
 Overrides the builtin Object.toString method. More...
 
String toString (DomainParticipantFactoryQos baseQos, QosPrintFormat format)
 Obtains a string representation of a DomainParticipantFactoryQos object. More...
 
String toString (QosPrintFormat format)
 Obtains a string representation of a DomainParticipantFactoryQos object. More...
 
String toString (DomainParticipantFactoryQos baseQos)
 Obtains a string representation of a DomainParticipantFactoryQos object. More...
 
- Public Member Functions inherited from Qos
final boolean equals (Object other)
 

Public Attributes

final EntityFactoryQosPolicy entity_factory
 Entity factory policy, ENTITY_FACTORY. More...
 
final SystemResourceLimitsQosPolicy resource_limits
 <<extension>> System resource limits, SYSTEM_RESOURCE_LIMITS. More...
 
final ProfileQosPolicy profile
 <<extension>> Qos profile policy, PROFILE. More...
 
final LoggingQosPolicy logging
 <<extension>> Logging qos policy, LOGGING. More...
 

Detailed Description

QoS policies supported by a com.rti.dds.domain.DomainParticipantFactory.

Entity:
com.rti.dds.domain.DomainParticipantFactory
See also
QoS Policies and 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 DomainParticipantFactoryQos object.

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

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

Returns
The string representation of the Qos.

Referenced by DomainParticipantFactoryQos.toString().

◆ toString() [2/4]

String toString ( DomainParticipantFactoryQos  baseQos,
QosPrintFormat  format 
)

Obtains a string representation of a DomainParticipantFactoryQos object.

Parameters
formatThe print format used to format the output.
baseQosOnly 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.DOMAINPARTICIPANTFACTORY_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.DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL.

◆ toString() [3/4]

String toString ( QosPrintFormat  format)

Obtains a string representation of a DomainParticipantFactoryQos object.

Parameters
formatThe 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 DomainParticipantFactoryQos.toString().

◆ toString() [4/4]

String toString ( DomainParticipantFactoryQos  baseQos)

Obtains a string representation of a DomainParticipantFactoryQos object.

Parameters
baseQosOnly 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.DOMAINPARTICIPANTFACTORY_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.

Returns
The string representation of the Qos.

References DomainParticipantFactoryQos.entity_factory, DomainParticipantFactoryQos.logging, DomainParticipantFactoryQos.profile, DomainParticipantFactoryQos.resource_limits, and DomainParticipantFactoryQos.toString().

Member Data Documentation

◆ entity_factory

final EntityFactoryQosPolicy entity_factory

Entity factory policy, ENTITY_FACTORY.

Referenced by DomainParticipantFactoryQos.toString().

◆ resource_limits

final SystemResourceLimitsQosPolicy resource_limits

<<extension>> System resource limits, SYSTEM_RESOURCE_LIMITS.

Note: This QoS policy cannot be configured from XML configuration files.

Referenced by DomainParticipantFactoryQos.toString().

◆ profile

final ProfileQosPolicy profile

<<extension>> Qos profile policy, PROFILE.

Note: This QoS policy cannot be configured from XML configuration files.

Referenced by DomainParticipantFactoryQos.toString().

◆ logging

final LoggingQosPolicy logging

<<extension>> Logging qos policy, LOGGING.

Referenced by DomainParticipantFactoryQos.toString().