rti::domain::DomainParticipantConfigParams Class Reference

<<extension>> <<value-type>> Input paramaters for creating a participant from xml configuration. It allows modification of some of the properties of the entities defined in the configuration. More...

#include "rti/domain/DomainParticipantConfigParams.hpp"

Public Member Functions
	DomainParticipantConfigParams (int32_t the_domain_id=DOMAIN_ID_USE_XML_CONFIG, const std::string &the_participant_name=ENTITY_NAME_USE_XML_CONFIG, const std::string &the_participant_qos_library_name=QOS_ELEMENT_NAME_USE_XML_CONFIG, const std::string &the_participant_qos_profile_name=QOS_ELEMENT_NAME_USE_XML_CONFIG, const std::string &the_domain_entity_qos_library_name=QOS_ELEMENT_NAME_USE_XML_CONFIG, const std::string &the_domain_entity_qos_profile_name=QOS_ELEMENT_NAME_USE_XML_CONFIG)
	Create a DomainParticipantConfigParams object with the specified values.
int32_t	domain_id () const
	Get the domain id.
DomainParticipantConfigParams &	domain_id (int32_t the_domain_id)
	Set the domain id from which the DomainParticipant is created.
std::string	participant_name () const
	Get the participant name.
DomainParticipantConfigParams &	participant_name (const std::string &the_participant_name)
	Set the name assigned to the DomainParticipant.
std::string	participant_qos_library_name () const
	Get the participant qos library name.
DomainParticipantConfigParams &	participant_qos_library_name (const std::string &the_participant_qos_library_name)
	Set the QoS library name containing the QoS profile from which the DDS_DomainParticipant is created.
std::string	participant_qos_profile_name () const
	Get the participant qos profile name.
DomainParticipantConfigParams &	participant_qos_profile_name (const std::string &the_participant_qos_profile_name)
	Set the QoS profile name from which the DomainParticipant is created.
std::string	domain_entity_qos_library_name () const
	Get the domain entity qos library name.
DomainParticipantConfigParams &	domain_entity_qos_library_name (const std::string &the_domain_entity_qos_library_name)
	Set the QoS library name containing the QoS profile from which the all the entities defined under the participant configuraton are created.
std::string	domain_entity_qos_profile_name () const
	Get the domain entity qos profile name.
DomainParticipantConfigParams &	domain_entity_qos_profile_name (const std::string &the_domain_entity_qos_profile_name)
	Set the QoS profile name from which the all the entities defined under the participant configuraton are created.

Static Public Attributes
static OMG_DDS_API_CLASS_VARIABLE const std::string	ENTITY_NAME_USE_XML_CONFIG
	Special value to be used to indicate that a participant should be created with an autogenerated entity name.
static OMG_DDS_API_CLASS_VARIABLE const std::string	QOS_ELEMENT_NAME_USE_XML_CONFIG
	Special value to be used to indicate that entities should be created from the QoS profile specified in the participant configuration.
static OMG_DDS_API_CLASS_VARIABLE const int32_t	DOMAIN_ID_USE_XML_CONFIG
	Special value to be used to indicate that a participant should be created using the domain ID specified in the participant configuration.

Detailed Description

<<extension>> <<value-type>> Input paramaters for creating a participant from xml configuration. It allows modification of some of the properties of the entities defined in the configuration.

See Also

dds::core::QosProvider::create_participant_from_config

Constructor & Destructor Documentation

rti::domain::DomainParticipantConfigParams::DomainParticipantConfigParams ( int32_t  the_domain_id = DOMAIN_ID_USE_XML_CONFIG, const std::string &  the_participant_name = ENTITY_NAME_USE_XML_CONFIG, const std::string &  the_participant_qos_library_name = QOS_ELEMENT_NAME_USE_XML_CONFIG, const std::string &  the_participant_qos_profile_name = QOS_ELEMENT_NAME_USE_XML_CONFIG, const std::string &  the_domain_entity_qos_library_name = QOS_ELEMENT_NAME_USE_XML_CONFIG, const std::string &  the_domain_entity_qos_profile_name = QOS_ELEMENT_NAME_USE_XML_CONFIG  )

inline

Create a DomainParticipantConfigParams object with the specified values.

All parameters are optional. If ommitted, the value for that parameter will be retrieved from the xml configuration.

Parameters

the_domain_id	Domain ID from which the DomainParticipant is created.
the_participant_name	The name assigned to the DomainParticipant
the_participant_qos_library_name	QoS library name containing the QoS profile from which the DDS_DomainParticipant is created.
the_participant_qos_profile_name	QoS profile name from which the DomainParticipant is created.
the_domain_entity_qos_library_name	QoS library name containing the QoS profile from which the all the entities defined under the participant configuraton are created.
the_domain_entity_qos_profile_name	QoS profile name from which the all the entities defined under the participant configuraton are created.

Member Function Documentation

int32_t rti::domain::DomainParticipantConfigParams::domain_id ( ) const

inline

Get the domain id.

See Also

domain_id(int32_t)

DomainParticipantConfigParams& rti::domain::DomainParticipantConfigParams::domain_id ( int32_t  the_domain_id )

inline

Set the domain id from which the DomainParticipant is created.

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

std::string rti::domain::DomainParticipantConfigParams::participant_name ( ) const

inline

Get the participant name.

See Also

participant_name(const std::string&)

DomainParticipantConfigParams& rti::domain::DomainParticipantConfigParams::participant_name ( const std::string &  the_participant_name )

inline

Set the name assigned to the DomainParticipant.

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

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

std::string rti::domain::DomainParticipantConfigParams::participant_qos_library_name ( ) const

inline

Get the participant qos library name.

See Also

participant_qos_library_name(const std::string&)

DomainParticipantConfigParams& rti::domain::DomainParticipantConfigParams::participant_qos_library_name ( const std::string &  the_participant_qos_library_name )

inline

Set the 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::domain::DomainParticipant.

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

std::string rti::domain::DomainParticipantConfigParams::participant_qos_profile_name ( ) const

inline

Get the participant qos profile name.

See Also

participant_qos_profile_name(const std::string&)

DomainParticipantConfigParams& rti::domain::DomainParticipantConfigParams::participant_qos_profile_name ( const std::string &  the_participant_qos_profile_name )

inline

Set the QoS profile name from which the DomainParticipant is created.

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

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

std::string rti::domain::DomainParticipantConfigParams::domain_entity_qos_library_name ( ) const

inline

Get the domain entity qos library name.

See Also

domain_entity_qos_library_name(const std::string&)

DomainParticipantConfigParams& rti::domain::DomainParticipantConfigParams::domain_entity_qos_library_name ( const std::string &  the_domain_entity_qos_library_name )

inline

Set the QoS library name containing the QoS profile from which the all the entities 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 DomainEntity.

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

std::string rti::domain::DomainParticipantConfigParams::domain_entity_qos_profile_name ( ) const

inline

Get the domain entity qos profile name.

See Also

DomainParticipantConfigParams& domain_entity_qos_profile_name(const std::string&)

DomainParticipantConfigParams& rti::domain::DomainParticipantConfigParams::domain_entity_qos_profile_name ( const std::string &  the_domain_entity_qos_profile_name )

inline

Set the QoS profile name from which the all the entities 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 DomainEntity.

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

Member Data Documentation

OMG_DDS_API_CLASS_VARIABLE const std::string rti::domain::DomainParticipantConfigParams::ENTITY_NAME_USE_XML_CONFIG

static

Special value to be used to indicate that a participant should be created with an autogenerated entity name.

OMG_DDS_API_CLASS_VARIABLE const std::string rti::domain::DomainParticipantConfigParams::QOS_ELEMENT_NAME_USE_XML_CONFIG

static

Special value to be used to indicate that entities should be created from the QoS profile specified in the participant configuration.

OMG_DDS_API_CLASS_VARIABLE const int32_t rti::domain::DomainParticipantConfigParams::DOMAIN_ID_USE_XML_CONFIG

static

Special value to be used to indicate that a participant should be created using the domain ID specified in the participant configuration.