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

<<value-type>> Container of the QoS policies that a dds::topic::Topic supports More...

#include <dds/topic/qos/TopicQos.hpp>

Public Member Functions

 TopicQos ()
 Creates a TopicQos with the default value for each policy.
 
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 >
TopicQospolicy (const Policy &p)
 Sets a policy.
 
template<typename Policy >
TopicQosoperator<< (const Policy &p)
 Sets a policy.
 
template<typename Policy >
const TopicQosoperator>> (Policy &p) const
 Copies the values of a policy.
 

Detailed Description

<<value-type>> Container of the QoS policies that a dds::topic::Topic supports

TopicQos Policies

A TopicQos 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::topic::qos::TopicQos::topic_data .value <= dds::domain::qos::DomainParticipantQos::resource_limits .topic_data_max_length

If any of the above are not true, dds::topic::Topic::qos(const dds::topic::qos::TopicQos&), dds::topic::Topic::qos() and dds::domain::DomainParticipant::default_topic_qos will fail with dds::core::InconsistentPolicyError and dds::topic::Topic::Topic() will return NULL.

Entity:
dds::topic::Topic
See Also
QoS Policies allowed ranges within each Qos.
Qos Use Cases

Constructor & Destructor Documentation

dds::topic::qos::TopicQos::TopicQos ( )
inline

Creates a TopicQos with the default value for each policy.

Member Function Documentation

template<typename POLICY >
const POLICY& dds::topic::qos::TopicQos::policy ( ) const

Gets a QoS policy by const reference.

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

Gets a QoS policy by reference.

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

Sets a policy.

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

Sets a policy.

See Also
policy()
Setting Qos Values
template<typename Policy >
const TopicQos& dds::topic::qos::TopicQos::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

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