dds::core::InstanceHandle Class Reference

Class to hold the handle associated with in sample instance. More...

#include "InstanceHandle.hpp"

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

Public Member Functions
	InstanceHandle ()
	InstanceHandle (const dds::core::null_type &nullHandle)
	InstanceHandle (const InstanceHandle &other)
bool	is_nil () const
bool	operator!= (const Value &other) const
D *	operator-> ()
const D *	operator-> () const
bool	operator< (const InstanceHandle &that) const
InstanceHandle &	operator= (const InstanceHandle &that)
bool	operator== (const InstanceHandle &that) const
bool	operator== (const Value &other) const
bool	operator> (const InstanceHandle &that) const

Static Public Member Functions
static const InstanceHandle	nil ()

Detailed Description

Class to hold the handle associated with in sample instance.

Definition at line 40 of file InstanceHandle.hpp.

Constructor & Destructor Documentation

InstanceHandle() [1/3]

dds::core::InstanceHandle::InstanceHandle

(

)

Create an nil instance handle.

InstanceHandle() [2/3]

dds::core::InstanceHandle::InstanceHandle

(

const dds::core::null_type &

nullHandle

)

Create an nil instance handle.

Parameters

nullHandle

placeholder

InstanceHandle() [3/3]

dds::core::InstanceHandle::InstanceHandle

(

const InstanceHandle &

other

)

Copy an existing InstancHandle

Parameters

other

InstanceHandle to copy

Member Function Documentation

is_nil()

bool dds::core::InstanceHandle::is_nil

(

)

const

Check if the InstanceHandle is nil.

Returns

true if the InstanceHandle is nil

nil()

static const InstanceHandle dds::core::InstanceHandle::nil ( )

static

Create an nil instance handle.

Returns

a nil InstanceHandle

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<()

bool dds::core::InstanceHandle::operator<

(

const InstanceHandle &

that

)

const

Compare this InstanceHandle to another InstanceHandle

Parameters

that	The InstanceHandle to compare

Returns

true if this is less than that

operator=()

InstanceHandle& dds::core::InstanceHandle::operator=

(

const InstanceHandle &

that

)

Assign an existing InstancHandle to this InstancHandle

Parameters

that	The InstanceHandle to assign to this

operator==() [1/2]

bool dds::core::InstanceHandle::operator==

(

const InstanceHandle &

that

)

const

Compare this InstanceHandle to another InstanceHandle

Parameters

that	The InstanceHandle to compare

Returns

true if they match

operator==() [2/2]

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

operator>()

bool dds::core::InstanceHandle::operator>

(

const InstanceHandle &

that

)

const

Compare this InstanceHandle to another InstanceHandle

Parameters

that	The InstanceHandle to compare

Returns

true if this is greater than that

---

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

• dds/core/InstanceHandle.hpp