RTI Connext Modern C++ API
Version 6.1.1
|
<<value-type>> Container of the QoS policies that a dds::domain::DomainParticipant supports More...
#include <dds/domain/qos/DomainParticipantQos.hpp>
Public Member Functions | |
DomainParticipantQos () | |
Creates a DomainParticipantQos with the default value for each policy. 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 > | |
DomainParticipantQos & | policy (const Policy &p) |
Sets a policy. More... | |
template<typename Policy > | |
DomainParticipantQos & | operator<< (const Policy &p) |
Sets a policy. More... | |
template<typename Policy > | |
const DomainParticipantQos & | 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 DomainParticipantQos &qos, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat()) |
<<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantQos More... | |
std::string | to_string (const DomainParticipantQos &qos, const DomainParticipantQos &base, const rti::core::QosPrintFormat &format=rti::core::QosPrintFormat()) |
<<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantQos More... | |
std::string | to_string (const DomainParticipantQos &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::domain::qos::DomainParticipantQos More... | |
std::ostream & | operator<< (std::ostream &out, const rti::domain::qos::DomainParticipantQos &qos) |
<<extension>> Prints a dds::sub::qos::DomainParticipantQos to an output stream. More... | |
<<value-type>> Container of the QoS policies that a dds::domain::DomainParticipant supports
A DomainParticipantQos contains the following policies:
To get or set policies use the policy() getters and setters or operator << (see examples).
Certain members must be set in a consistent manner:
Length of dds::domain::qos::DomainParticipantQos::user_data .value <= dds::domain::qos::DomainParticipantQos::resource_limits .participant_user_data_max_length
For dds::domain::qos::DomainParticipantQos::discovery_config .publication_writer
high_watermark <= dds::domain::qos::DomainParticipantQos::resource_limits .local_writer_allocation .max_count heartbeats_per_max_samples <= dds::domain::qos::DomainParticipantQos::resource_limits .local_writer_allocation.max_count
For dds::domain::qos::DomainParticipantQos::discovery_config .suscription_writer
high_watermark <= dds::domain::qos::DomainParticipantQos::resource_limits .local_reader_allocation.max_count heartbeats_per_max_samples <= dds::domain::qos::DomainParticipantQos::resource_limits .local_reader_allocation.max_count
If any of the above are not true, dds::domain::DomainParticipant::qos(const dds::domain::qos::DomainParticipantQos&) and dds::domain::DomainParticipant::set_qos_with_profile and dds::domain::DomainParticipant::default_participant_qos() will fail with dds::core::InconsistentPolicyError, and the dds::domain::DomainParticipant constructors will fail with dds::core::Error
dds::domain::qos::DomainParticipantQos::DomainParticipantQos | ( | ) |
Creates a DomainParticipantQos with the default value for each policy.
const POLICY& dds::domain::qos::DomainParticipantQos::policy | ( | ) | const |
Gets a QoS policy by const reference.
Policy | One of the DomainParticipantQos Policies |
POLICY& dds::domain::qos::DomainParticipantQos::policy | ( | ) |
Gets a QoS policy by reference.
Policy | One of the DomainParticipantQos 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::domain::qos::DomainParticipantQos
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::domain::qos::DomainParticipantQos
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::domain::qos::DomainParticipantQos
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::sub::qos::DomainParticipantQos to an output stream.