dds::core::policy::History Class Reference

More...

#include "CorePolicy.hpp"

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

Public Member Functions
	History (const History &other)
	History (dds::core::policy::HistoryKind::Type kind=dds::core::policy::HistoryKind::KEEP_LAST, int32_t depth=1)
int32_t	depth () const
History &	depth (int32_t depth)
dds::core::policy::HistoryKind::Type	kind () const
History &	kind (dds::core::policy::HistoryKind::Type kind)
bool	operator!= (const Value &other) const
D *	operator-> ()
const D *	operator-> () const
bool	operator== (const Value &other) const

Static Public Member Functions
static History	KeepAll ()
static History	KeepLast (uint32_t depth)

Detailed Description

Definition at line 1091 of file CorePolicy.hpp.

Constructor & Destructor Documentation

History() [1/2]

dds::core::policy::History::History	(	dds::core::policy::HistoryKind::Type	kind = dds::core::policy::HistoryKind::KEEP_LAST,
		int32_t	depth = 1
	)

Creates a History QoS instance

Parameters

kind	the kind
depth	the history depth

History() [2/2]

dds::core::policy::History::History

(

const History &

other

)

Copies a History QoS instance

Parameters

other

the History QoS instance to copy

Member Function Documentation

depth() [1/2]

int32_t dds::core::policy::History::depth

(

)

const

Gets the history depth

Returns

the history depth

depth() [2/2]

History& dds::core::policy::History::depth

(

int32_t

depth

)

Sets the history depth

Parameters

the	history depth

KeepAll()

static History dds::core::policy::History::KeepAll ( )

static

Returns

a History QoS instance with the kind set to KEEP_ALL

KeepLast()

static History dds::core::policy::History::KeepLast ( uint32_t  depth )

static

Parameters

depth

the history depth

Returns

a History QoS instance with the kind set to KEEP_LAST and the depth set to the supplied value

kind() [1/2]

dds::core::policy::HistoryKind::Type dds::core::policy::History::kind

(

)

const

Gets the kind

Returns

the kind

kind() [2/2]

History& dds::core::policy::History::kind

(

dds::core::policy::HistoryKind::Type

kind

)

Sets the kind

Parameters

kind

the kind

operator!=()

template<typename D >

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

inherited

Compare this Value with another Value

Parameters

other

Value

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

other

Value

Returns

true if equal

---

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

• dds/core/policy/CorePolicy.hpp