dds::domain::qos::DomainParticipantQos Class Reference

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

Detailed Description

<<value-type>> Container of the QoS policies that a dds::domain::DomainParticipant supports

DomainParticipantQos Policies

A DomainParticipantQos contains the following policies:

• dds::core::policy::UserData,
• dds::core::policy::EntityFactory,
• rti::core::policy::WireProtocol,
• rti::core::policy::TransportBuiltin,
• rti::core::policy::TransportUnicast,
• rti::core::policy::Discovery,
• rti::core::policy::DomainParticipantResourceLimits,
• rti::core::policy::Event,
• rti::core::policy::ReceiverPool,
• rti::core::policy::Database,
• rti::core::policy::DiscoveryConfig,
• rti::core::policy::Property,
• rti::core::policy::EntityName,
• rti::core::policy::TransportMulticastMapping
• rti::core::policy::Service
• rti::core::policy::Partition

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

Entity:

dds::domain::DomainParticipant

See also

QoS Policies and allowed ranges within each Qos.

NDDS_DISCOVERY_PEERS

Qos Use Cases

Constructor & Destructor Documentation

DomainParticipantQos()

dds::domain::qos::DomainParticipantQos::DomainParticipantQos

(

)

Creates a DomainParticipantQos with the default value for each policy.

Member Function Documentation

policy() [1/3]

template<typename POLICY >

const POLICY & dds::domain::qos::DomainParticipantQos::policy

(

)

const

Gets a QoS policy by const reference.

Template Parameters

Policy

One of the DomainParticipantQos Policies

See also

Setting Qos Values

policy() [2/3]

template<typename POLICY >

POLICY & dds::domain::qos::DomainParticipantQos::policy

(

)

Gets a QoS policy by reference.

Template Parameters

Policy

One of the DomainParticipantQos Policies

See also

Setting Qos Values

policy() [3/3]

template<typename Policy >

DomainParticipantQos & dds::domain::qos::DomainParticipantQos::policy ( const Policy &  p )

inline

Sets a policy.

See also

policy()

Setting Qos Values

operator<<()

template<typename Policy >

DomainParticipantQos & dds::domain::qos::DomainParticipantQos::operator<< ( const Policy &  p )

inline

Sets a policy.

See also

policy()

Setting Qos Values

operator>>()

template<typename Policy >

const DomainParticipantQos & dds::domain::qos::DomainParticipantQos::operator>> ( Policy &  p ) const

inline

Copies the values of a policy.

Parameters

p	The destination where to copy the current value of the Policy

See also

policy()

Setting Qos Values

Friends And Related Function Documentation

to_string() [1/3]

std::string to_string ( const DomainParticipantQos &  qos, const rti::core::QosPrintFormat &  format = rti::core::QosPrintFormat()  )

related

<<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantQos

Parameters

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.

DomainParticipantQos qos;
 
// When no QosPrintFormat is supplied, the default is used. Similarly, since
// no base profile has been specified we will only print the differences
// with respect to the documented default for DomainParticipantQos
std::string str = to_string(qos);
 
// In this overload we are specifying the print format used to format the output
// string.
QosPrintFormat format; // ...;
str = to_string(qos, format);
 
// Here, the differences between qos and base will be included in the output
// string. If the two qos objects are the same, the resulting string will
// be empty.
DomainParticipantQos base; // ...;
str = to_string(qos, base);
// We could also specify the format at this point
str = to_string(qos, base, format);
 
// Instead of supplying a base profile, the sentinel value qos_print_all can
// be supplied. This will result in the entire Qos object being printed (as
// opposed to only the differences with respect to a base qos).
str = to_string(qos, qos_print_all);

This overload uses the default print format and only prints the differences between qos and the documented default.

Returns

The string representation of the qos

to_string() [2/3]

std::string to_string ( const DomainParticipantQos &  qos, const DomainParticipantQos &  base, const rti::core::QosPrintFormat &  format = rti::core::QosPrintFormat()  )

related

<<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantQos

Parameters

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.

Returns

The string representation of the qos

to_string() [3/3]

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()  )

related

<<extension>> Obtains a string representation of the dds::domain::qos::DomainParticipantQos

Parameters

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:

to_string(qos, rti::core::qos_print_all);

Returns

The string representation of the qos

operator<<()

std::ostream & operator<< ( std::ostream &  out, const rti::domain::qos::DomainParticipantQos &  qos  )

related

<<extension>> Prints a dds::sub::qos::DomainParticipantQos to an output stream.