RTI Connext .NET API (legacy)  Version 6.1.2
DDS::DomainParticipantFactoryQos Class Reference

QoS policies supported by a DDS::DomainParticipantFactory. More...

#include <managed_domain.h>

Public Member Functions

bool equals (DomainParticipantFactoryQos^ other)
 Compares two DDS::DomainParticipantFactoryQos for equality. More...
 
virtual System::String ^ ToString () override
 Overrides the builtin ToString method. More...
 
System::String ^ ToString (DomainParticipantFactoryQos^ base, QosPrintFormat^ format)
 Obtains a string representation of a DomainParticipantFactoryQos object. More...
 
System::String ^ ToString (QosPrintFormat^ format)
 Obtains a string representation of a DomainParticipantFactoryQos object. More...
 
System::String ^ ToString (DomainParticipantFactoryQos^ base)
 Obtains a string representation of a DomainParticipantFactoryQos object. More...
 

Public Attributes

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

Detailed Description

QoS policies supported by a DDS::DomainParticipantFactory.

Entity:
DDS::DomainParticipantFactory
See also
QoS Policies and allowed ranges within each Qos.

Member Function Documentation

◆ ToString() [1/4]

virtual System::String ^ DDS::DomainParticipantFactoryQos::ToString ( )
overridevirtual

Overrides the builtin 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
// 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 base = new DomainParticipantFactoryQos();
theString = qos.toString(base);
// It is also possible to supply a custom format at this point
QosPrintFormat printFormat = new QosPrintFormat();
theString = qos.ToString(base, 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.

◆ ToString() [2/4]

System::String ^ DDS::DomainParticipantFactoryQos::ToString ( DomainParticipantFactoryQos base,
QosPrintFormat format 
)

Obtains a string representation of a DomainParticipantFactoryQos object.

Parameters
formatThe print format used to format the output.
baseOnly the differences between base and the Qos object are included in the output string. If you want to print everything within the Qos, use the DDS::DomainParticipant::DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the qos and the supplied base. The output string is formatted using the supplied DDS::QosPrintFormat.

Returns
The string representation of the Qos.

◆ ToString() [3/4]

System::String ^ DDS::DomainParticipantFactoryQos::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 DDS::QosPrintFormat.

Returns
The string representation of the Qos.

◆ ToString() [4/4]

System::String ^ DDS::DomainParticipantFactoryQos::ToString ( DomainParticipantFactoryQos base)

Obtains a string representation of a DomainParticipantFactoryQos object.

Parameters
baseOnly the differences between base and the Qos object are included in the output string. If you want to print everything within the Qos, use the DDS::DomainParticipant::DOMAINPARTICIPANTFACTORY_QOS_PRINT_ALL sentinel value.

This overload prints the differences between the qos and the supplied base. The output string is formatted using the default value for DDS::QosPrintFormat.

Returns
The string representation of the Qos.

Member Data Documentation

◆ entity_factory

EntityFactoryQosPolicy DDS::DomainParticipantFactoryQos::entity_factory

Entity factory policy, ENTITY_FACTORY.

◆ resource_limits

SystemResourceLimitsQosPolicy DDS::DomainParticipantFactoryQos::resource_limits

<<extension>> System resource limits, SYSTEM_RESOURCE_LIMITS.

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

◆ profile

ProfileQosPolicy ^ DDS::DomainParticipantFactoryQos::profile

<<extension>> Qos profile policy, PROFILE.

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

◆ logging

LoggingQosPolicy ^ DDS::DomainParticipantFactoryQos::logging

<<extension>> Logging qos policy, LOGGING.