DomainParticipantConfigParams_t Class Reference

<<extension>> Input paramaters for creating a participant from configuration. It allows to modify or override some of the properties of the entities defined in the configuration. More...

Inherits Struct.

Public Attributes
int	domain_id = DOMAIN_ID_USE_XML_CONFIG
	Domain ID from which the com.rti.dds.domain.DomainParticipant is created. More...
String	participant_name
	Name assigned to the com.rti.dds.domain.DomainParticipant. More...
String	participant_qos_library_name
	QoS library name containing the QoS profile from which the com.rti.dds.domain.DomainParticipant is created. More...
String	participant_qos_profile_name
	QoS profile name from which the com.rti.dds.domain.DomainParticipant is created. More...
String	domain_entity_qos_library_name
	QoS library name containing the QoS profile from which the all the com.rti.dds.infrastructure.DomainEntity defined under the participant configuration are created. More...
String	domain_entity_qos_profile_name
	QoS profile name from which the all the com.rti.dds.infrastructure.DomainEntity defined under the participant configuration are created. More...

Static Public Attributes
static final int	DOMAIN_ID_USE_XML_CONFIG = -1
	<<extension>> Special value to be used with com.rti.dds.infrastructure.DomainParticipantConfigParams_t to indicate that a participant is created using the domain ID specified in the participant configuration. More...
static final String	ENTITY_NAME_USE_XML_CONFIG
	<<extension>> Special value to be used with com.rti.dds.infrastructure.DomainParticipantConfigParams_t to indicate that a participant created is with an autogenerated entity name. More...
static final String	QOS_ELEMENT_NAME_USE_XML_CONFIG
	<<extension>> Special value to be used with com.rti.dds.infrastructure.DomainParticipantConfigParams_t to indicate that entities are created from the QoS profile specified in the participant configuration. More...

Detailed Description

<<extension>> Input paramaters for creating a participant from configuration. It allows to modify or override some of the properties of the entities defined in the configuration.

Member Data Documentation

DOMAIN_ID_USE_XML_CONFIG

final int DOMAIN_ID_USE_XML_CONFIG = -1

static

<<extension>> Special value to be used with com.rti.dds.infrastructure.DomainParticipantConfigParams_t to indicate that a participant is created using the domain ID specified in the participant configuration.

This variable contains a constant sentinel value that is compared when creating the entities from configuration.

ENTITY_NAME_USE_XML_CONFIG

final String ENTITY_NAME_USE_XML_CONFIG

static

Initial value:

= 
            "com.rti.dds.domain.entity_name_use_xml_config"

<<extension>> Special value to be used with com.rti.dds.infrastructure.DomainParticipantConfigParams_t to indicate that a participant created is with an autogenerated entity name.

This variable contains a constant sentinel value that is lexicographically compared when creating the entities from configuration.

QOS_ELEMENT_NAME_USE_XML_CONFIG

final String QOS_ELEMENT_NAME_USE_XML_CONFIG

static

Initial value:

= 
            "com.rti.dds.domain.qos_element_name_use_xml_config"

<<extension>> Special value to be used with com.rti.dds.infrastructure.DomainParticipantConfigParams_t to indicate that entities are created from the QoS profile specified in the participant configuration.

This variable contains a constant sentinel value that is lexicographically compared when creating the entities from configuration.

domain_id

int domain_id = DOMAIN_ID_USE_XML_CONFIG

Domain ID from which the com.rti.dds.domain.DomainParticipant is created.

Allows overriding the domain ID defined in the configuration for the participant to be created. If the special value com.rti.dds.infrastructure.DomainParticipantConfigParams_t.DOMAIN_ID_USE_XML_CONFIG is specified then the ID in the configuration will be used.

participant_name

String participant_name

Initial value:

= new String(
            ENTITY_NAME_USE_XML_CONFIG)

Name assigned to the com.rti.dds.domain.DomainParticipant.

This is the name the name that will be set in the com.rti.dds.domain.DomainParticipantQos.participant_name. It allows overriding the participant name that is generated automatically.

When this member is lexicographically equal to the special value com.rti.dds.infrastructure.DomainParticipantConfigParams_t.ENTITY_NAME_USE_XML_CONFIG then an automatically generated name will be assigned.

participant_qos_library_name

String participant_qos_library_name

Initial value:

= new String(
            QOS_ELEMENT_NAME_USE_XML_CONFIG)

QoS library name containing the QoS profile from which the com.rti.dds.domain.DomainParticipant is created.

Allows overriding the QoS defined in the configuration for the participant to be created. This value only affects to the com.rti.dds.domain.DomainParticipant.

When this member is lexicographically equal to the special value com.rti.dds.infrastructure.DomainParticipantConfigParams_t.QOS_ELEMENT_NAME_USE_XML_CONFIG then the QoS library from the configuration will be applied. Also, the same action will apply for the QoS profile and the value in com.rti.dds.infrastructure.DomainParticipantConfigParams_t.participant_qos_profile_name will be ignored.

participant_qos_profile_name

String participant_qos_profile_name

Initial value:

= new String(
            QOS_ELEMENT_NAME_USE_XML_CONFIG)

QoS profile name from which the com.rti.dds.domain.DomainParticipant is created.

Allows overriding the QoS defined in the configuration for the participant to be created.This value only affects to the com.rti.dds.domain.DomainParticipant.

When this member is lexicographically equal to the special value com.rti.dds.infrastructure.DomainParticipantConfigParams_t.QOS_ELEMENT_NAME_USE_XML_CONFIG then the QoS profile from the configuration will be applied. Also, the same action will apply for the QoS library and the value in com.rti.dds.infrastructure.DomainParticipantConfigParams_t.participant_qos_library_name will be ignored.

domain_entity_qos_library_name

String domain_entity_qos_library_name

Initial value:

= new String(
            QOS_ELEMENT_NAME_USE_XML_CONFIG)

QoS library name containing the QoS profile from which the all the com.rti.dds.infrastructure.DomainEntity defined under the participant configuration are created.

Allows overriding the QoS defined in the configuration for the domain entities to be created. This value only affects to the com.rti.dds.infrastructure.DomainEntity.

When this member is lexicographically equal to the special value com.rti.dds.infrastructure.DomainParticipantConfigParams_t.QOS_ELEMENT_NAME_USE_XML_CONFIG then the QoS library from the configuration will be applied. Also, the same action will apply for the QoS profile and the value in com.rti.dds.infrastructure.DomainParticipantConfigParams_t.domain_entity_qos_profile_name will be ignored.

domain_entity_qos_profile_name

String domain_entity_qos_profile_name

Initial value:

= new String(
            QOS_ELEMENT_NAME_USE_XML_CONFIG)

QoS profile name from which the all the com.rti.dds.infrastructure.DomainEntity defined under the participant configuration are created.

Allows overriding the QoS defined in the configuration for the domain entities to be created. This value only affects to the com.rti.dds.infrastructure.DomainEntity.

When this member is lexicographically equal to the special value com.rti.dds.infrastructure.DomainParticipantConfigParams_t.QOS_ELEMENT_NAME_USE_XML_CONFIG then the QoS profile from the configuration will be applied. Also, the same action will apply for the QoS library and the value in com.rti.dds.infrastructure.DomainParticipantConfigParams_t.domain_entity_qos_library_name will be ignored.