OpenSplice ISO C++ 2 DCPS  v6.x
ISO C++ 2 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
dds::core::EntityQos Class Reference

QoS Container. More...

#include "EntityQos.hpp"

Inheritance diagram for dds::core::EntityQos:
Inheritance graph

Public Member Functions

 EntityQos ()
 
 EntityQos (const EntityQos &other)
 
template<typename T >
 EntityQos (const EntityQos< T > &qos)
 
bool operator!= (const Value &other) const
 
D * operator-> ()
 
const D * operator-> () const
 
template<typename POLICY >
EntityQosoperator<< (const POLICY &p)
 
template<typename T >
EntityQosoperator= (const EntityQos< T > &other)
 
bool operator== (const Value &other) const
 
template<typename POLICY >
const EntityQosoperator>> (POLICY &p) const
 
template<typename POLICY >
EntityQospolicy (const POLICY &p)
 
template<typename POLICY >
const POLICY & policy () const
 
template<typename POLICY >
POLICY & policy ()
 

Detailed Description

QoS Container.

Acts as a container for Qos policies allowing all the policies of an entity to be set and retrieved as a unit.

For more information see Infrastructure Module and Supported Quality of Service

Definition at line 45 of file EntityQos.hpp.

Constructor & Destructor Documentation

◆ EntityQos() [1/3]

dds::core::EntityQos::EntityQos ( )

Create default QoS.

Definition at line 40 of file EntityQosImpl.hpp.

◆ EntityQos() [2/3]

dds::core::EntityQos::EntityQos ( const EntityQos other)

Create copied QoS.

Parameters
otherthe QoS to copy.

Definition at line 43 of file EntityQosImpl.hpp.

◆ EntityQos() [3/3]

template<typename T >
dds::core::EntityQos::EntityQos ( const EntityQos< T > &  qos)

Create/copy QoS from different QoS type.

Parameters
qosthe QoS to copy policies from.

Member Function Documentation

◆ operator!=()

template<typename D >
bool dds::core::Value< D >::operator!= ( const Value< D > &  other) const
inherited

Compare this Value with another Value

Parameters
otherValue
Returns
true if not equal

Definition at line 99 of file Value.hpp.

◆ operator->() [1/2]

template<typename D >
D * dds::core::Value< D >::operator-> ( )
inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();
Returns
a reference to delegate.

Definition at line 111 of file Value.hpp.

◆ operator->() [2/2]

template<typename D >
const D * dds::core::Value< D >::operator-> ( ) const
inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();
Returns
a reference to delegate.

Definition at line 105 of file Value.hpp.

◆ operator<<()

template<typename POLICY >
EntityQos& dds::core::EntityQos::operator<< ( const POLICY &  p)

Generic function for setting a policy applicable to this QoS object. Available policies depend on the actual instantiation of the template class, which might be DomainParticipantQos, TopicQos, PublisherQos, etc.

Parameters
pthe policy to be set for this QoS instance.

◆ operator=()

template<typename T >
EntityQos& dds::core::EntityQos::operator= ( const EntityQos< T > &  other)

Generic function for setting a policy applicable to this QoS object. Available policies depend on the actual instantiation of the template class, which might be DomainParticipantQos, TopicQos, PublisherQos, etc.

Parameters
EntityQosthe EntityQos to set

◆ operator==()

template<typename D >
bool dds::core::Value< D >::operator== ( const Value< D > &  other) const
inherited

Compare this Value with another Value

Parameters
otherValue
Returns
true if equal

Definition at line 93 of file Value.hpp.

◆ operator>>()

template<typename POLICY >
const EntityQos& dds::core::EntityQos::operator>> ( POLICY &  p) const

Generic function for obtaining the value of a specific policy belonging to this QoS instance.

Returns
policy

◆ policy() [1/3]

template<typename POLICY >
EntityQos& dds::core::EntityQos::policy ( const POLICY &  p)

Generic function for setting a policy applicable to this QoS object. Available policies depend on the actual instantiation of the template class, which might be DomainParticipantQos, TopicQos, PublisherQos, etc.

Parameters
pthe policy to be set for this QoS instance.

◆ policy() [2/3]

template<typename POLICY >
const POLICY& dds::core::EntityQos::policy ( ) const

Generic function for obtaining the value of a specific policy belonging to this QoS instance.

Returns
policy

◆ policy() [3/3]

template<typename POLICY >
POLICY& dds::core::EntityQos::policy ( )

Generic function for obtaining the value of a specific policy belonging to this QoS instance.

Returns
policy

The documentation for this class was generated from the following files: