RTI Connext Modern C++ API
Version 7.0.0
|
<<extension>> <<value-type>> Configure options that control the way that XML documents containing QoS profiles are loaded by a dds::core::QosProvider. More...
#include <rti/core/QosProviderParams.hpp>
Public Member Functions | |
QosProviderParams () | |
Create a QosProviderParams with default settings. More... | |
const dds::core::StringSeq | string_profile () const |
Get the current list of string profiles stored by this QosProviderParams. More... | |
QosProviderParams & | string_profile (const dds::core::StringSeq &the_string_profile) |
Set the current list of string profiles stored by this QosProviderParams. More... | |
const dds::core::StringSeq | url_profile () const |
Get the current list of URL groups stored by this QosProviderParams. More... | |
QosProviderParams & | url_profile (const dds::core::StringSeq &the_url_profile) |
Set the current list of URL groups stored by this QosProviderParams. More... | |
bool | ignore_user_profile () const |
Get the value that is currently set for ignore_user_profile. More... | |
QosProviderParams & | ignore_user_profile (bool the_ignore_user_profile) |
Choose whether or not to ignore USER_QOS_PROFILES.xml. More... | |
bool | ignore_environment_profile () const |
Get the value that is currently set for ignore_environment_profile. More... | |
QosProviderParams & | ignore_environment_profile (bool the_ignore_environment_profile) |
Choose whether or not to ignore the NDDS_QOS_PROFILES. More... | |
bool | ignore_resource_profile () const |
Get the value that is currently set for ignore_resource_profile. More... | |
QosProviderParams & | ignore_resource_profile (bool the_ignore_resource_profile) |
Choose whether or not to ignore NDDS_QOS_PROFILES.xml. More... | |
<<extension>> <<value-type>> Configure options that control the way that XML documents containing QoS profiles are loaded by a dds::core::QosProvider.
All QoS values for Entities can be configured in QoS profiles defined in XML documents. XML documents can be passed to RTI Connext in string form or, more likely, through files found on a file system.
There are also default locations where DomainParticipants will look for files to load QoS profiles. These include the current working directory from where an application is started, a file in the distribution directory for RTI Connext, and the locations specified by an environment variable.
You may disable any or all of these default locations using the Profile QoS policy.
Note: This class is equivalent to DDS_ProfileQosPolicy the other RTI Connext language APIs.
|
inline |
Create a QosProviderParams with default settings.
const dds::core::StringSeq rti::core::QosProviderParams::string_profile | ( | ) | const |
Get the current list of string profiles stored by this QosProviderParams.
QosProviderParams& rti::core::QosProviderParams::string_profile | ( | const dds::core::StringSeq & | the_string_profile | ) |
Set the current list of string profiles stored by this QosProviderParams.
the_string_profile | A sequence of strings containing an XML document to load. The concatenation of the strings in this sequence must be a valid XML document according to the XML QoS profile schema. |
[default] An empty list
const dds::core::StringSeq rti::core::QosProviderParams::url_profile | ( | ) | const |
Get the current list of URL groups stored by this QosProviderParams.
QosProviderParams& rti::core::QosProviderParams::url_profile | ( | const dds::core::StringSeq & | the_url_profile | ) |
Set the current list of URL groups stored by this QosProviderParams.
the_url_profile | Sequence of URL groups containing a set of XML documents to load. Only one of the elements of each group will be loaded by RTI Connext, starting from the left. |
[default] An empty list
bool rti::core::QosProviderParams::ignore_user_profile | ( | ) | const |
Get the value that is currently set for ignore_user_profile.
QosProviderParams& rti::core::QosProviderParams::ignore_user_profile | ( | bool | the_ignore_user_profile | ) |
Choose whether or not to ignore USER_QOS_PROFILES.xml.
When this field is set to true, the QoS profiles contained in the file USER_QOS_PROFILES.xml in the current working directory will not be loaded.
the_ignore_user_profile | Whether or not to ignore the USER_QOS_PROFILES.xml in the current working directory. |
[default] false
bool rti::core::QosProviderParams::ignore_environment_profile | ( | ) | const |
Get the value that is currently set for ignore_environment_profile.
QosProviderParams& rti::core::QosProviderParams::ignore_environment_profile | ( | bool | the_ignore_environment_profile | ) |
Choose whether or not to ignore the NDDS_QOS_PROFILES.
When this field is set to true, the QoS profiles pointed to by the NDDS_QOS_PROFILES will not be loaded.
the_ignore_environment_profile | Whether or not to ignore NDDS_QOS_PROFILES. |
[default] false
bool rti::core::QosProviderParams::ignore_resource_profile | ( | ) | const |
Get the value that is currently set for ignore_resource_profile.
QosProviderParams& rti::core::QosProviderParams::ignore_resource_profile | ( | bool | the_ignore_resource_profile | ) |
Choose whether or not to ignore NDDS_QOS_PROFILES.xml.
When this field is set to true, the QoS profiles contained in the file NDDS_QOS_PROFILES.xml in $NDDSHOME/resource/qos_profiles_../xml will not be loaded.
the_ignore_resource_profile | Whether or not to ignore the NDDS_QOS_PROFILES.xml. |
[default] false