RTI Connext Modern C++ API
Version 7.0.0
|
<<value-type>> Container of the QoS policies that a dds::pub::Publisher supports More...
#include <dds/pub/qos/PublisherQos.hpp>
Public Member Functions | |
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 > | |
PublisherQos & | policy (const Policy &p) |
Sets a policy. More... | |
template<typename Policy > | |
PublisherQos & | operator<< (const Policy &p) |
Sets a policy. More... | |
template<typename Policy > | |
const PublisherQos & | operator>> (Policy &p) const |
Copies the values of a policy. More... | |
Related Functions | |
(Note that these are not member functions.) | |
void | swap (PublisherQosImpl &left, PublisherQosImpl &right) OMG_NOEXCEPT |
Swap the contents of two PublisherQos objects. More... | |
std::string | to_string (const PublisherQos &qos, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat()) |
<<extension>> Obtains a string representation of the dds::pub::qos::PublisherQos More... | |
std::string | to_string (const PublisherQos &qos, const PublisherQos &base, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat()) |
<<extension>> Obtains a string representation of the dds::pub::qos::PublisherQos More... | |
std::string | to_string (const PublisherQos &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::pub::qos::PublisherQos More... | |
std::ostream & | operator<< (std::ostream &out, const rti::pub::qos::PublisherQos &qos) |
<<extension>> Prints a dds::pub::qos::PublisherQos to an output stream. More... | |
<<value-type>> Container of the QoS policies that a dds::pub::Publisher supports
A PublisherQos 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:
length of dds::core::policy::GroupData::value <= rti::core::policy::DomainParticipantResourceLimits::publisher_group_data_max_length
length of dds::core::policy::Partition::name <= rti::core::policy::DomainParticipantResourceLimits::max_partitions
combined number of characters (including terminating 0) in dds::core::policy::Partition::name <= rti::core::policy::DomainParticipantResourceLimits::max_partition_cumulative_characters
If any of the above are not true, dds::pub::Publisher::qos(const dds::pub::qos::PublisherQos&) and dds::pub::Publisher::set_qos_with_profile will fail with dds::core::InconsistentPolicyError and the dds::pub::Publisher constructors will fail with dds::core::Error
const POLICY& dds::pub::qos::PublisherQos::policy | ( | ) | const |
Gets a QoS policy by const reference.
Policy | One of the PublisherQos Policies |
POLICY& dds::pub::qos::PublisherQos::policy | ( | ) |
Gets a QoS policy by reference.
Policy | One of the PublisherQos 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 |
Swap the contents of two PublisherQos objects.
left | A PublisherQos |
right | The other PublisherQos |
|
related |
<<extension>> Obtains a string representation of the dds::pub::qos::PublisherQos
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::PublisherQos
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::pub::qos::PublisherQos
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::PublisherQos to an output stream.