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

Detailed Description

<<value-type>> Container of the QoS policies that a dds::pub::Publisher supports

PublisherQos Policies

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

See also: Qos Use Cases

Member Function Documentation

◆ policy() [1/3]

template<typename POLICY >

const POLICY & dds::pub::qos::PublisherQos::policy ( ) const

Gets a QoS policy by const reference.

Template Parameters

Policy One of the PublisherQos Policies

See also: Setting Qos Values

◆ policy() [2/3]

template<typename POLICY >

POLICY & dds::pub::qos::PublisherQos::policy ( )

Gets a QoS policy by reference.

Template Parameters

Policy One of the PublisherQos Policies

See also: Setting Qos Values

◆ policy() [3/3]

template<typename Policy >

PublisherQos & dds::pub::qos::PublisherQos::policy ( const Policy & p )

inline

Sets a policy.

See also: policy(); Setting Qos Values

◆ operator<<()

template<typename Policy >

PublisherQos & dds::pub::qos::PublisherQos::operator<< ( const Policy & p )

inline

Sets a policy.

See also: policy(); Setting Qos Values

◆ operator>>()

template<typename Policy >

const PublisherQos & dds::pub::qos::PublisherQos::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

◆ swap()

void swap	(	PublisherQosImpl &	left,
		PublisherQosImpl &	right
	)

Parameters

left	A PublisherQos
right	The other PublisherQos

◆ to_string() [1/3]

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

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.

PublisherQos 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 PublisherQos
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.
PublisherQos 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 PublisherQos &	qos,
		const PublisherQos &	base,
		const rti::core::QosPrintFormat &	format = `rti::core::QosPrintFormat()`
	)

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 PublisherQos &	qos,
		const rti::core::qos_print_all_t &	qos_print_all,
		const rti::core::QosPrintFormat &	format = `rti::core::QosPrintFormat()`
	)

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::pub::qos::PublisherQos &	qos
	)

Public Member Functions

Related Functions

Detailed Description

PublisherQos Policies

Member Function Documentation

◆ policy() [1/3]

◆ policy() [2/3]

◆ policy() [3/3]

◆ operator<<()

◆ operator>>()

Friends And Related Function Documentation

◆ swap()

◆ to_string() [1/3]

◆ to_string() [2/3]

◆ to_string() [3/3]

◆ operator<<()