RTI Connext Modern C++ API  Version 5.3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::core::QosProviderParams Class Reference

<<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.
 
dds::core::StringSeq string_profile () const
 Get the current list of string profiles stored by this QosProviderParams.
 
QosProviderParamsstring_profile (const dds::core::StringSeq &the_string_profile)
 Set the current list of string profiles stored by this QosProviderParams.
 
dds::core::StringSeq url_profile () const
 Get the current list of URL groups stored by this QosProviderParams.
 
QosProviderParamsurl_profile (const dds::core::StringSeq &the_url_profile)
 Set the current list of URL groups stored by this QosProviderParams.
 
bool ignore_user_profile () const
 Get the value that is currently set for ignore_user_profile.
 
QosProviderParamsignore_user_profile (bool the_ignore_user_profile)
 Choose whether or not to ignore USER_QOS_PROFILES.xml.
 
bool ignore_environment_profile () const
 Get the value that is currently set for ignore_environment_profile.
 
QosProviderParamsignore_environment_profile (bool the_ignore_environment_profile)
 Choose whether or not to ignore the NDDS_QOS_PROFILES.
 
bool ignore_resource_profile () const
 Get the value that is currently set for ignore_resource_profile.
 
QosProviderParamsignore_resource_profile (bool the_ignore_resource_profile)
 Choose whether or not to ignore NDDS_QOS_PROFILES.xml.
 

Detailed Description

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

Constructor & Destructor Documentation

rti::core::QosProviderParams::QosProviderParams ( )
inline

Create a QosProviderParams with default settings.

Member Function Documentation

dds::core::StringSeq rti::core::QosProviderParams::string_profile ( ) const

Get the current list of string profiles stored by this QosProviderParams.

Returns
dds::core::StringSeq The list of string profiles.
QosProviderParams& rti::core::QosProviderParams::string_profile ( const dds::core::StringSeq the_string_profile)

Set the current list of string profiles stored by this QosProviderParams.

Parameters
the_string_profileA 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

dds::core::StringSeq rti::core::QosProviderParams::url_profile ( ) const

Get the current list of URL groups stored by this QosProviderParams.

Returns
dds::core::StringSeq The list of string profiles.
QosProviderParams& rti::core::QosProviderParams::url_profile ( const dds::core::StringSeq the_url_profile)

Set the current list of URL groups stored by this QosProviderParams.

Parameters
the_url_profileSequence 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.

Returns
bool Whether or not the dds::core::QosProvider set with these QosProviderParams will ignore the USER_QOS_PROFILES.xml.
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.

Parameters
the_ignore_user_profileWhether or not to ignore the USER_QOS_PROFILES.xml in the current working directory.
Returns
QosProviderParams& This QosProviderParams

[default] false

bool rti::core::QosProviderParams::ignore_environment_profile ( ) const

Get the value that is currently set for ignore_environment_profile.

Returns
bool Whether or not the dds::core::QosProvider set with these QosProviderParams will ignore the NDDS_QOS_PROFILES.
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.

Parameters
the_ignore_environment_profileWhether or not to ignore NDDS_QOS_PROFILES.
Returns
QosProviderParams& This QosProviderParams

[default] false

bool rti::core::QosProviderParams::ignore_resource_profile ( ) const

Get the value that is currently set for ignore_resource_profile.

Returns
bool Whether or not the dds::core::QosProvider set with these QosProviderParams will ignore NDDS_QOS_PROFILES.xml.
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_5.3.0/xml will not be loaded.

Parameters
the_ignore_resource_profileWhether or not to ignore the NDDS_QOS_PROFILES.xml.
Returns
QosProviderParams& This QosProviderParams

[default] false


RTI Connext Modern C++ API Version 5.3.0 Copyright © Sun Jun 25 2017 Real-Time Innovations, Inc