RTI Connext C# API Version 7.2.0
Rti.Dds.Domain.DomainParticipantFactoryQos Class Reference

QoS policies supported by the DomainParticipantFactory. More...

Inherits IEquatable< DomainParticipantFactoryQos >.

Public Member Functions

DomainParticipantFactoryQos WithEntityFactory (EntityFactory value)
 Creates a copy of this DomainParticipantFactoryQos instance with a new value for EntityFactory More...
 
DomainParticipantFactoryQos WithResourceLimits (SystemResourceLimits policy)
 Creates an instance with a new ResourceLimits policy. More...
 
DomainParticipantFactoryQos WithResourceLimits (Action< SystemResourceLimitsBuilder > build)
 Creates a new instance with a new ResourceLimits policy as configured by a build action. More...
 
DomainParticipantFactoryQos WithMonitoring (Monitoring value)
 Creates a copy of this DomainParticipantFactoryQos instance with a new value for Monitoring More...
 
DomainParticipantFactoryQos WithMonitoring (Action< MonitoringBuilder > build)
 Creates a new instance with a new Monitoring policy as configured by a build action. More...
 
override bool Equals (object other)
 Compares all the policies for equality More...
 
override int GetHashCode ()
 Returns the hash code by combining that of each policy More...
 
bool Equals (DomainParticipantFactoryQos other)
 Compares all the policies for equality More...
 
override string ToString ()
 Returns an XML representation of the QoS object. More...
 
string ToString (QosPrintFormat format)
 Returns an XML representation of the QoS object. More...
 
string ToString (DomainParticipantFactoryQos baseQos, QosPrintFormat format=null)
 Returns an XML representation of the QoS object. More...
 
string ToString (QosPrintAll baseQos, QosPrintFormat format=null)
 Returns an XML representation of the QoS object. More...
 

Properties

EntityFactory EntityFactory [get]
 Gets the value of EntityFactory More...
 
SystemResourceLimits ResourceLimits [get]
 Gets the value of ResourceLimits More...
 
Monitoring Monitoring [get]
 Gets the value of Monitoring More...
 
static DomainParticipantFactoryQos Default = CreateDefault() [get]
 Singleton containing the default value of a DomainParticipantFactoryQos More...
 

Detailed Description

QoS policies supported by the DomainParticipantFactory.

The full documentation is available in the C API: DDS_DomainParticipantFactoryQos

Member Function Documentation

◆ WithEntityFactory()

DomainParticipantFactoryQos Rti.Dds.Domain.DomainParticipantFactoryQos.WithEntityFactory ( EntityFactory  value)
inline

Creates a copy of this DomainParticipantFactoryQos instance with a new value for EntityFactory

Parameters
valueThe new value for EntityFactory
Returns
A copy with a new value for EntityFactory

◆ WithResourceLimits() [1/2]

DomainParticipantFactoryQos Rti.Dds.Domain.DomainParticipantFactoryQos.WithResourceLimits ( SystemResourceLimits  policy)
inline

Creates an instance with a new ResourceLimits policy.

Parameters
policyThe new policy
Returns
A new instance with the same policies as the current instance, except for the one being set

◆ WithResourceLimits() [2/2]

DomainParticipantFactoryQos Rti.Dds.Domain.DomainParticipantFactoryQos.WithResourceLimits ( Action< SystemResourceLimitsBuilder build)

Creates a new instance with a new ResourceLimits policy as configured by a build action.

Parameters
buildA function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy
Returns
A new instance with the sames policies as the current instance, except for the policy being modified

◆ WithMonitoring() [1/2]

DomainParticipantFactoryQos Rti.Dds.Domain.DomainParticipantFactoryQos.WithMonitoring ( Monitoring  value)
inline

Creates a copy of this DomainParticipantFactoryQos instance with a new value for Monitoring

Parameters
valueThe new value for EntityFactory
Returns
A copy with a new value for EntityFactory

◆ WithMonitoring() [2/2]

DomainParticipantFactoryQos Rti.Dds.Domain.DomainParticipantFactoryQos.WithMonitoring ( Action< MonitoringBuilder build)

Creates a new instance with a new Monitoring policy as configured by a build action.

Parameters
buildA function receiving the current values of the policy as an argument. The changes performed by this build function will be used to create the new policy
Returns
A new instance with the sames policies as the current instance, except for the policy being modified

◆ Equals() [1/2]

override bool Rti.Dds.Domain.DomainParticipantFactoryQos.Equals ( object  other)

Compares all the policies for equality

◆ GetHashCode()

override int Rti.Dds.Domain.DomainParticipantFactoryQos.GetHashCode ( )
inline

Returns the hash code by combining that of each policy

◆ Equals() [2/2]

bool Rti.Dds.Domain.DomainParticipantFactoryQos.Equals ( DomainParticipantFactoryQos  other)
inline

Compares all the policies for equality

◆ ToString() [1/4]

override string Rti.Dds.Domain.DomainParticipantFactoryQos.ToString ( )

Returns an XML representation of the QoS object.

The output is formatted using the default values for the QosPrintFormat and only QoS policies which differ from the documented default are included.

◆ ToString() [2/4]

string Rti.Dds.Domain.DomainParticipantFactoryQos.ToString ( QosPrintFormat  format)

Returns an XML representation of the QoS object.

Parameters
formatThe baseQos profile.

This overload accepts a value for the baseQos. Only the differences between the DomainParticipantFactoryQos object being printed and the baseQos are included in the output.

◆ ToString() [3/4]

string Rti.Dds.Domain.DomainParticipantFactoryQos.ToString ( DomainParticipantFactoryQos  baseQos,
QosPrintFormat  format = null 
)

Returns an XML representation of the QoS object.

Parameters
baseQosThe baseQos profile.
formatthe format used to configure the output. If not supplied the output is formatted using the default format.

This overload accepts a value for the baseQos. Only the differences between the DomainParticipantFactoryQos object being printed and the baseQos are included in the output.

◆ ToString() [4/4]

string Rti.Dds.Domain.DomainParticipantFactoryQos.ToString ( QosPrintAll  baseQos,
QosPrintFormat  format = null 
)

Returns an XML representation of the QoS object.

Parameters
baseQosUsed to indicate that the entire QoS object should be included in the output. The only value which should be provided for this argument is QosPrintAll.Value
formatThe format used to configure the output. If not supplied, the output is formatted using the default format.

This overload accepts a parameter of type QosPrintAll. Unlike the other ToString overloads, the entire QoS object will be included in the output.

Property Documentation

◆ EntityFactory

EntityFactory Rti.Dds.Domain.DomainParticipantFactoryQos.EntityFactory
get

Gets the value of EntityFactory

The full documentation is available in the C API: DDS_DomainParticipantFactoryQos_entity_factory

◆ ResourceLimits

SystemResourceLimits Rti.Dds.Domain.DomainParticipantFactoryQos.ResourceLimits
get

Gets the value of ResourceLimits

The full documentation is available in the C API: DDS_DomainParticipantFactoryQos_resource_limits

◆ Monitoring

Monitoring Rti.Dds.Domain.DomainParticipantFactoryQos.Monitoring
get

Gets the value of Monitoring

The full documentation is available in the C API: DDS_DomainParticipantFactoryQos_monitoring

◆ Default

DomainParticipantFactoryQos Rti.Dds.Domain.DomainParticipantFactoryQos.Default = CreateDefault()
staticget

Singleton containing the default value of a DomainParticipantFactoryQos