DDS::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...

#include <managed_infrastructure.h>

Public Attributes
System::Int32	domain_id
	Domain ID from which the DDS::DomainParticipant is created. More...
System::String ^	participant_name
	Name assigned to the DDS::DomainParticipant. More...
System::String ^	participant_qos_library_name
	QoS library name containing the QoS profile from which the DDS::DomainParticipant is created. More...
System::String ^	participant_qos_profile_name
	QoS profile name from which the DDS::DomainParticipant is created. More...
System::String ^	domain_entity_qos_library_name
	QoS library name containing the QoS profile from which the all the DDS::DomainEntity defined under the participant configuraton are created. More...
System::String ^	domain_entity_qos_profile_name
	QoS profile name from which the all the DDS::DomainEntity defined under the participant configuraton are created. More...

Properties
static System::Int32	DOMAIN_ID_USE_XML_CONFIG [get]
	<<extension>> Special value to be used with DDS::DomainParticipantConfigParams_t to indicate that a participant is created using the domain ID specified in the participant configuration. More...
static System::String^	ENTITY_NAME_USE_XML_CONFIG [get]
	<<extension>> Special value to be used with DDS::DomainParticipantConfigParams_t to indicate that a participant created is with an autogenerated entity name. More...
static System::String^	QOS_ELEMENT_NAME_USE_XML_CONFIG [get]
	<<extension>> Special value to be used with DDS::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

System::Int32 DDS::DomainParticipantConfigParams_t::domain_id

Domain ID from which the DDS::DomainParticipant is created.

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

participant_name

System::String ^ DDS::DomainParticipantConfigParams_t::participant_name

Name assigned to the DDS::DomainParticipant.

This is the name the name that will be set in the DDS::DomainParticipantQos::participant_name. It allows overriding the participant name that is generated automatically.

When this member is lexicographically equal to the special value DDS::DomainParticipantConfigParams_t::ENTITY_NAME_USE_XML_CONFIG then an automatically generated name will be assigned.

participant_qos_library_name

System::String ^ DDS::DomainParticipantConfigParams_t::participant_qos_library_name

QoS library name containing the QoS profile from which the DDS::DomainParticipant is created.

Allows overriding the QoS defined in the configuration for the participant to be created. This value only affects to the DDS::DomainParticipant.

When this member is lexicographically equal to the special value DDS::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 DDS::DomainParticipantConfigParams_t::participant_qos_profile_name will be ignored.

participant_qos_profile_name

System::String ^ DDS::DomainParticipantConfigParams_t::participant_qos_profile_name

QoS profile name from which the DDS::DomainParticipant is created.

Allows overriding the QoS defined in the configuration for the participant to be created.This value only affects to the DDS::DomainParticipant.

When this member is lexicographically equal to the special value DDS::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 DDS::DomainParticipantConfigParams_t::participant_qos_library_name will be ignored.

domain_entity_qos_library_name

System::String ^ DDS::DomainParticipantConfigParams_t::domain_entity_qos_library_name

QoS library name containing the QoS profile from which the all the DDS::DomainEntity defined under the participant configuraton are created.

Allows overriding the QoS defined in the configuration for the domain entities to be created. This value only affects to the DDS::DomainEntity.

When this member is lexicographically equal to the special value DDS::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 DDS::DomainParticipantConfigParams_t::domain_entity_qos_profile_name will be ignored.

domain_entity_qos_profile_name

System::String ^ DDS::DomainParticipantConfigParams_t::domain_entity_qos_profile_name

QoS profile name from which the all the DDS::DomainEntity defined under the participant configuraton are created.

Allows overriding the QoS defined in the configuration for the domain entities to be created. This value only affects to the DDS::DomainEntity.

When this member is lexicographically equal to the special value DDS::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 DDS::DomainParticipantConfigParams_t::domain_entity_qos_library_name will be ignored.

Property Documentation

DOMAIN_ID_USE_XML_CONFIG

System:: Int32 DDS::DomainParticipantConfigParams_t::DOMAIN_ID_USE_XML_CONFIG

staticget

<<extension>> Special value to be used with DDS::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

System:: String^ DDS::DomainParticipantConfigParams_t::ENTITY_NAME_USE_XML_CONFIG

staticget

<<extension>> Special value to be used with DDS::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

System:: String^ DDS::DomainParticipantConfigParams_t::QOS_ELEMENT_NAME_USE_XML_CONFIG

staticget

<<extension>> Special value to be used with DDS::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.