Cyclone ISO C++ API Reference Guide
dds::core::policy::ReaderDataLifecycle Class Reference

More...

#include "CorePolicy.hpp"

Inherits dds::core::Value< D >.

Public Member Functions

 ReaderDataLifecycle (const dds::core::Duration &autopurge_nowriter_samples_delay=dds::core::Duration::infinite(), const dds::core::Duration &autopurge_disposed_samples_delay=dds::core::Duration::infinite())
 
 ReaderDataLifecycle (const ReaderDataLifecycle &other)
 
const dds::core::Duration autopurge_disposed_samples_delay () const
 
ReaderDataLifecycleautopurge_disposed_samples_delay (const dds::core::Duration &autopurge_disposed_samples_delay)
 
const dds::core::Duration autopurge_nowriter_samples_delay () const
 
ReaderDataLifecycleautopurge_nowriter_samples_delay (const dds::core::Duration &autopurge_nowriter_samples_delay)
 
bool operator!= (const Value &other) const
 
D * operator-> ()
 
const D * operator-> () const
 
bool operator== (const Value &other) const
 

Static Public Member Functions

static ReaderDataLifecycle AutoPurgeDisposedSamples (const dds::core::Duration &autopurge_disposed_samples_delay)
 
static ReaderDataLifecycle NoAutoPurgeDisposedSamples ()
 

Detailed Description

Definition at line 734 of file CorePolicy.hpp.

Constructor & Destructor Documentation

◆ ReaderDataLifecycle() [1/2]

dds::core::policy::ReaderDataLifecycle::ReaderDataLifecycle ( const dds::core::Duration autopurge_nowriter_samples_delay = dds::core::Duration::infinite(),
const dds::core::Duration autopurge_disposed_samples_delay = dds::core::Duration::infinite() 
)

Creates a ReaderDataLifecycle QoS instance

Parameters
autopurge_nowriter_samples_delaythe autopurge nowriter samples delay
autopurge_disposed_samples_delaythe autopurge disposed samples delay

◆ ReaderDataLifecycle() [2/2]

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

Copies a ReaderDataLifecycle QoS instance

Parameters
otherthe ReaderDataLifecycle QoS instance to copy

Member Function Documentation

◆ autopurge_disposed_samples_delay() [1/2]

const dds::core::Duration dds::core::policy::ReaderDataLifecycle::autopurge_disposed_samples_delay ( ) const

Gets the autopurge_disposed_samples_delay

Returns
the autopurge disposed samples delay

◆ autopurge_disposed_samples_delay() [2/2]

ReaderDataLifecycle& dds::core::policy::ReaderDataLifecycle::autopurge_disposed_samples_delay ( const dds::core::Duration autopurge_disposed_samples_delay)

Sets the autopurge_disposed_samples_delay

Returns
the autopurge disposed samples delay

◆ autopurge_nowriter_samples_delay() [1/2]

const dds::core::Duration dds::core::policy::ReaderDataLifecycle::autopurge_nowriter_samples_delay ( ) const

Gets the autopurge nowriter samples delay

Returns
the autopurge nowriter samples delay

◆ autopurge_nowriter_samples_delay() [2/2]

ReaderDataLifecycle& dds::core::policy::ReaderDataLifecycle::autopurge_nowriter_samples_delay ( const dds::core::Duration autopurge_nowriter_samples_delay)

Sets the autopurge nowriter samples delay

Parameters
autopurge_nowriter_samples_delaythe autopurge nowriter samples delay

◆ AutoPurgeDisposedSamples()

static ReaderDataLifecycle dds::core::policy::ReaderDataLifecycle::AutoPurgeDisposedSamples ( const dds::core::Duration autopurge_disposed_samples_delay)
static
Parameters
autopurge_disposed_samples_delaythe autopurge disposed samples delay
Returns
a ReaderDataLifecycle QoS instance with autopurge_disposed_samples_delay set to a specified value

◆ NoAutoPurgeDisposedSamples()

static ReaderDataLifecycle dds::core::policy::ReaderDataLifecycle::NoAutoPurgeDisposedSamples ( )
static
Returns
a ReaderDataLifecycle QoS instance which will not autopurge disposed samples

◆ 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

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

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

◆ 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

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