Class astutedds::dcps::XmlQosLoader

ClassList > astutedds > dcps > XmlQosLoader

Loads and caches DDS XML QoS profiles. More...

• #include <xml_config.hpp>

Public Functions

Type	Name
	XmlQosLoader () = default
	XmlQosLoader (const XmlQosLoader &) = delete
	XmlQosLoader (XmlQosLoader &&) noexcept
void	clear () Clear all loaded profiles.
bool	get_datareader_qos (const std::string & profile_key, DataReaderQos & qos) const Look up a DataReaderQos for the named profile.
bool	get_datawriter_qos (const std::string & profile_key, DataWriterQos & qos) const
bool	get_participant_qos (const std::string & profile_key, DomainParticipantQos & qos) const Look up a DomainParticipantQos for the named profile.
bool	get_topic_qos (const std::string & profile_key, TopicQos & qos) const Look up a TopicQos for the named profile.
bool	load_file (const std::string & path)
bool	load_string (const std::string & xml)
XmlQosLoader &	operator= (const XmlQosLoader &) = delete
XmlQosLoader &	operator= (XmlQosLoader &&) noexcept
std::vector< std::string >	profile_keys () const Returns all loaded profile keys ("Library::Profile").
	~XmlQosLoader () = default

Detailed Description

Thread-safe. Multiple files may be loaded; later loads merge with earlier ones and duplicate profile names are overwritten.

Public Functions Documentation

function XmlQosLoader [1/3]

astutedds::dcps::XmlQosLoader::XmlQosLoader () = default

---

function XmlQosLoader [2/3]

astutedds::dcps::XmlQosLoader::XmlQosLoader (
    const XmlQosLoader &
) = delete

---

function XmlQosLoader [3/3]

astutedds::dcps::XmlQosLoader::XmlQosLoader (
    XmlQosLoader &&
) noexcept

---

function clear

Clear all loaded profiles.

void astutedds::dcps::XmlQosLoader::clear () 

---

function get_datareader_qos

Look up a DataReaderQos for the named profile.

bool astutedds::dcps::XmlQosLoader::get_datareader_qos (
    const std::string & profile_key,
    DataReaderQos & qos
) const

---

function get_datawriter_qos

bool astutedds::dcps::XmlQosLoader::get_datawriter_qos (
    const std::string & profile_key,
    DataWriterQos & qos
) const

Look up a DataWriterQos for the named profile ("Library::Profile").

Returns:

true and fills qos on success. Base-profile inheritance is resolved automatically.

---

function get_participant_qos

Look up a DomainParticipantQos for the named profile.

bool astutedds::dcps::XmlQosLoader::get_participant_qos (
    const std::string & profile_key,
    DomainParticipantQos & qos
) const

---

function get_topic_qos

Look up a TopicQos for the named profile.

bool astutedds::dcps::XmlQosLoader::get_topic_qos (
    const std::string & profile_key,
    TopicQos & qos
) const

---

function load_file

bool astutedds::dcps::XmlQosLoader::load_file (
    const std::string & path
) 

Load profiles from an XML file.

Returns:

true on success, false if the file cannot be opened or parsed.

---

function load_string

bool astutedds::dcps::XmlQosLoader::load_string (
    const std::string & xml
) 

Load profiles from an in-memory XML string.

Returns:

true on success, false on parse error.

---

function operator=

XmlQosLoader & astutedds::dcps::XmlQosLoader::operator= (
    const XmlQosLoader &
) = delete

---

function operator=

XmlQosLoader & astutedds::dcps::XmlQosLoader::operator= (
    XmlQosLoader &&
) noexcept

---

function profile_keys

Returns all loaded profile keys ("Library::Profile").

std::vector< std::string > astutedds::dcps::XmlQosLoader::profile_keys () const

---

function ~XmlQosLoader

astutedds::dcps::XmlQosLoader::~XmlQosLoader () = default

---

---

The documentation for this class was generated from the following file include/astutedds/dcps/xml_config.hpp