RTI Connext Modern C++ API Version 7.1.0
|
<<value-type>> Container of the QoS policies that a dds::pub::DataWriter supports More...
#include <dds/pub/qos/DataWriterQos.hpp>
Public Member Functions | |
DataWriterQos () | |
Creates a DataWriterQos with the default value for each policy. More... | |
DataWriterQos (const dds::topic::qos::TopicQos &topic_qos) | |
Creates a DataWriterQos with the policies of a given TopicQos. More... | |
DataWriterQos & | operator= (const dds::topic::qos::TopicQos &topic_qos) |
Copies into this DataWriterQos those policies that are also in TopicQos. More... | |
template<typename Policy > | |
const Policy & | policy () const |
Gets a QoS policy by const reference. More... | |
template<typename Policy > | |
Policy & | policy () |
Gets a QoS policy by reference. More... | |
template<typename Policy > | |
DataWriterQos & | policy (const Policy &p) |
Sets a policy. More... | |
template<typename Policy > | |
DataWriterQos & | operator<< (const Policy &p) |
Sets a policy. More... | |
template<typename Policy > | |
const DataWriterQos & | operator>> (Policy &p) const |
Copies the values of a policy. More... | |
Related Functions | |
(Note that these are not member functions.) | |
std::string | to_string (const DataWriterQos &qos, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat()) |
<<extension>> Obtains a string representation of the dds::pub::qos::DataWriterQos More... | |
std::string | to_string (const DataWriterQos &qos, const DataWriterQos &base, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat()) |
<<extension>> Obtains a string representation of the dds::pub::qos::DataWriterQos More... | |
std::string | to_string (const DataWriterQos &qos, const rti::core::qos_print_all_t &qos_print_all, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat()) |
<<extension>> Obtains a string representation of the dds::sub::qos::DataWriterQos More... | |
std::ostream & | operator<< (std::ostream &out, const rti::pub::qos::DataWriterQos &qos) |
<<extension>> Prints a dds::pub::qos::DataWriterQos to an output stream. More... | |
<<value-type>> Container of the QoS policies that a dds::pub::DataWriter supports
A DataWriterQos contains the following policies:
To get or set policies use the policy() getters and setters or operator << (see examples).
You must set certain members in a consistent manner:
If any of the above are not true, dds::pub::DataWriter::qos(const dds::pub::qos::DataWriterQos&) and dds::pub::Publisher::default_datawriter_qos(const dds::pub::qos::DataWriterQos&) will fail with dds::core::InconsistentPolicyError and the dds::pub::DataWriter constructors will fail with dds::core::Error
dds::pub::qos::DataWriterQos::DataWriterQos | ( | ) |
Creates a DataWriterQos with the default value for each policy.
dds::pub::qos::DataWriterQos::DataWriterQos | ( | const dds::topic::qos::TopicQos & | topic_qos | ) |
Creates a DataWriterQos with the policies of a given TopicQos.
The QoS policies that are exclusive to a DataWriter retain their default values. A dds::topic::qos::TopicQos contains a subset of the policies of a DataWriterQos. This constructor copies those common policies while initializing the policies that are only defined in DataWriterQos to their default values.
topic_qos | The TopicQos being copied. |
Example:
|
inline |
Copies into this DataWriterQos those policies that are also in TopicQos.
A dds::topic::qos::TopicQos contains a subset of the policies of a DataWriterQos. This assignment operator copies those common policies into this instance while leaving the policies that are only defined in DataWriterQos unaltered.
topic_qos | The TopicQos to copy the common policies from. |
For example:
const Policy & dds::pub::qos::DataWriterQos::policy | ( | ) | const |
Gets a QoS policy by const reference.
Policy | One of the DataWriterQos policies |
Policy & dds::pub::qos::DataWriterQos::policy | ( | ) |
Gets a QoS policy by reference.
Policy | One of the DataWriterQos policies |
|
inline |
Sets a policy.
|
inline |
Sets a policy.
|
inline |
Copies the values of a policy.
p | The destination where to copy the current value of the Policy |
|
related |
<<extension>> Obtains a string representation of the dds::pub::qos::DataWriterQos
qos | The qos object to convert to a string |
format | The optional print format used to format the output string. |
The several to_string overloads allow formatting the output and printing only the differences with respect to another Qos object.
This overload uses the default print format and only prints the differences between qos and the documented default.
|
related |
<<extension>> Obtains a string representation of the dds::pub::qos::DataWriterQos
qos | The qos object to convert to a string |
base | The base qos. Only the differences between base and qos are included in the output string. If you want to print everything within the QoS, use the overload that accepts a rti::core::qos_print_all_t. |
format | The optional print format used to format the output string. |
This overload prints the differences between qos and base. If no print format is specified, the default will be used.
|
related |
<<extension>> Obtains a string representation of the dds::sub::qos::DataWriterQos
qos | The qos object to convert to a string |
qos_print_all | The sentinel value indicating that the entire QoS should be converted to a string. The other overloads of this API only print the differences with respect to a base profile, or to the documented default. |
format | The optional print format used to format the output string. |
This overload prints all of the policies within qos. If no print format is specified, the default will be used.
The only valid value for the qos_print_all argument is rti::core::qos_print_all
For example:
|
related |
<<extension>> Prints a dds::pub::qos::DataWriterQos to an output stream.