RTI Connext .NET API (legacy)  Version 6.1.2
DomainParticipantFactory

DDS::DomainParticipantFactory entity and associated elements More...

Classes

class  DDS::DomainParticipantFactoryQos
 QoS policies supported by a DDS::DomainParticipantFactory. More...
 
class  DDS::DomainParticipantFactory
 <<singleton>> <<interface>> Allows creation and destruction of DDS::DomainParticipant objects. More...
 

Functions

bool DDS::DomainParticipantFactoryQos::equals (DomainParticipantFactoryQos^ other)
 Compares two DDS::DomainParticipantFactoryQos for equality. More...
 

Properties

static DomainParticipantQosDDS::DomainParticipantFactory::PARTICIPANT_QOS_DEFAULT [get]
 Special value for creating a DomainParticipant with default QoS. More...
 
static DomainParticipantConfigParams_tDDS::DomainParticipantFactory::PARTICIPANT_CONFIG_PARAMS_DEFAULT [get]
 Special value for creating a DDS::DomainParticipant from configuration using default parameters. More...
 

Detailed Description

DDS::DomainParticipantFactory entity and associated elements

Function Documentation

◆ equals()

bool DDS::DomainParticipantFactoryQos::equals ( DomainParticipantFactoryQos other)

Compares two DDS::DomainParticipantFactoryQos for equality.

Parameters
other<<in>> The other DomainParticipantFactoryQos to be compared with this DomainParticipantFactoryQos.
Returns
true if the two Qos objects are equal or false otherwise.

Properties

◆ PARTICIPANT_QOS_DEFAULT

DomainParticipantQos^ DDS::DomainParticipantFactory::PARTICIPANT_QOS_DEFAULT
staticget

Special value for creating a DomainParticipant with default QoS.

When used in DDS::DomainParticipantFactory::create_participant, this special value is used to indicate that the DDS::DomainParticipant should be created with the default DDS::DomainParticipant QoS by means of the operation DDS::DomainParticipantFactory::get_default_participant_qos() and using the resulting QoS to create the DDS::DomainParticipant.

When used in DDS::DomainParticipantFactory::set_default_participant_qos, this special value is used to indicate that the default QoS should be reset back to the initial value that would be used if the DDS::DomainParticipantFactory::set_default_participant_qos operation had never been called.

When used in DDS::DomainParticipant::set_qos, this special value is used to indicate that the QoS of the DDS::DomainParticipant should be changed to match the current default QoS set in the DDS::DomainParticipantFactory that the DDS::DomainParticipant belongs to.

RTI Connext treats this special value as a constant.

Warning
This value is a constant and should never be modified. You cannot use this value to get the default QoS values from the DomainParticipant factory; for this purpose, use DDS::DomainParticipantFactory::get_default_participant_qos.
See also
NDDS_DISCOVERY_PEERS
DDS::DomainParticipantFactory::create_participant()
DDS::DomainParticipantFactory::set_default_participant_qos()
DDS::DomainParticipant::set_qos()
Examples:
HelloWorld_publisher.cpp, HelloWorld_publisher.cs, HelloWorld_subscriber.cpp, and HelloWorld_subscriber.cs.

◆ PARTICIPANT_CONFIG_PARAMS_DEFAULT

DomainParticipantConfigParams_t^ DDS::DomainParticipantFactory::PARTICIPANT_CONFIG_PARAMS_DEFAULT
staticget

Special value for creating a DDS::DomainParticipant from configuration using default parameters.

This value can be used only in DDS::DomainParticipantFactory::create_participant_from_config_w_params and indicates that the DDS::DomainParticipant must be created applying the information defined in the participant configuration. That is, the domain ID, participant entity name, and QoS profiles for all the entities will be retrieved from the configuration.

RTI Connext treats this special value as a constant.

See also
DDS::DomainParticipantConfigParams_t
DDS::DomainParticipantFactory::create_participant_from_config_w_params