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

More...

#include "CorePolicy.hpp"

Inheritance diagram for dds::core::policy::OwnershipStrength:
Inheritance graph

Public Member Functions

 OwnershipStrength (int32_t strength=0)
 
 OwnershipStrength (const OwnershipStrength &other)
 
bool operator!= (const Value &other) const
 
D * operator-> ()
 
const D * operator-> () const
 
bool operator== (const Value &other) const
 
int32_t value () const
 
OwnershipStrengthvalue (int32_t strength)
 

Detailed Description

This QosPolicy specifies the value of the ownership strength of a DataWriter used to determine the ownership of an instance.

Attributes

Value Meaning Concerns RxO Changeable
A long:
value
Specifies the value of the "strength" used to arbitrate among multiple DataWriter objects that attempt to modify the same instance of a data-object(identified by Topic + key). This policy only applies if the OWNERSHIP QoS policy is of kind EXCLUSIVE. The default value of the ownership_strength is zero. DataWriter N/A Yes

This QoS policy should be used in combination with the OWNERSHIP policy. It only applies to the situation case where OWNERSHIP kind is set to EXCLUSIVE. The value of the OWNERSHIP_STRENGTH is used to determine the ownership of a data-instance (identified by the key). The arbitration is performed by the DataReader.

Definition at line 638 of file CorePolicy.hpp.

Constructor & Destructor Documentation

◆ OwnershipStrength() [1/2]

dds::core::policy::OwnershipStrength::OwnershipStrength ( int32_t  strength = 0)
explicit

Creates an OwnershipStrength QoS instance

Parameters
strengthownership strength

Definition at line 497 of file CorePolicyImpl.hpp.

◆ OwnershipStrength() [2/2]

dds::core::policy::OwnershipStrength::OwnershipStrength ( const OwnershipStrength other)

Copies an OwnershipStrength QoS instance

Parameters
otherthe OwnershipStrength QoS instance to copy

Definition at line 500 of file CorePolicyImpl.hpp.

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

◆ value() [1/2]

int32_t dds::core::policy::OwnershipStrength::value ( ) const

Gets the ownership strength value

Returns
the ownership strength value

Definition at line 503 of file CorePolicyImpl.hpp.

◆ value() [2/2]

OwnershipStrength & dds::core::policy::OwnershipStrength::value ( int32_t  strength)

Sets the ownership strength value

Parameters
strengththe ownership strength value

Definition at line 509 of file CorePolicyImpl.hpp.


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