RTI Connext Modern C++ API  Version 5.2.3
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
dds::pub::qos::PublisherQos Class Reference

<<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.
 
template<typename POLICY >
POLICY & policy ()
 Gets a QoS policy by reference.
 
template<typename Policy >
PublisherQospolicy (const Policy &p)
 Sets a policy.
 
template<typename Policy >
PublisherQosoperator<< (const Policy &p)
 Sets a policy.
 
template<typename Policy >
const PublisherQosoperator>> (Policy &p) const
 Copies the values of a policy.
 

Related Functions

(Note that these are not member functions.)

void swap (PublisherQosImpl &left, PublisherQosImpl &right) OMG_NOEXCEPT
 Swap the contents of two PublisherQos objects.
 

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 dds::domain::DomainParticipant::create_publisher will return NULL.

See Also
Qos Use Cases

Member Function Documentation

template<typename POLICY >
const POLICY& dds::pub::qos::PublisherQos::policy ( ) const

Gets a QoS policy by const reference.

Template Parameters
PolicyOne of the PublisherQos Policies
See Also
Setting Qos Values
template<typename POLICY >
POLICY& dds::pub::qos::PublisherQos::policy ( )

Gets a QoS policy by reference.

Template Parameters
PolicyOne of the PublisherQos Policies
See Also
Setting Qos Values
template<typename Policy >
PublisherQos& dds::pub::qos::PublisherQos::policy ( const Policy &  p)
inline

Sets a policy.

See Also
policy()
Setting Qos Values
template<typename Policy >
PublisherQos& dds::pub::qos::PublisherQos::operator<< ( const Policy &  p)
inline

Sets a policy.

See Also
policy()
Setting Qos Values
template<typename Policy >
const PublisherQos& dds::pub::qos::PublisherQos::operator>> ( Policy &  p) const
inline

Copies the values of a policy.

Parameters
pThe destination where to copy the current value of the Policy
See Also
policy()
Setting Qos Values

Friends And Related Function Documentation

void swap ( PublisherQosImpl &  left,
PublisherQosImpl &  right 
)
related

Swap the contents of two PublisherQos objects.

Parameters
leftA PublisherQos
rightThe other PublisherQos

RTI Connext Modern C++ API Version 5.2.3 Copyright © Wed Apr 27 2016 Real-Time Innovations, Inc