Class InstanceHandle

• Defined in File InstanceHandle.hpp

Inheritance Relationships

Base Type

• public dds::core::Value< detail::InstanceHandle > (Template Class Value)

Class Documentation

class InstanceHandle : public dds::core::Value<detail::InstanceHandle>

Class to hold the handle associated with in sample instance.

Public Functions

OMG_DDS_API InstanceHandle()

Create an nil instance handle.

OMG_DDS_API InstanceHandle(const null_type &nullHandle)

Create an nil instance handle.

Parameters:

nullHandle – placeholder

OMG_DDS_API InstanceHandle(const InstanceHandle &other)

Copy an existing InstancHandle

Parameters:

other – InstanceHandle to copy

OMG_DDS_API InstanceHandle & operator= (const InstanceHandle &that)

Assign an existing InstancHandle to this InstancHandle

Parameters:

that – The InstanceHandle to assign to this

OMG_DDS_API bool operator== (const InstanceHandle &that) const

Compare this InstanceHandle to another InstanceHandle

Parameters:

that – The InstanceHandle to compare

Returns:

true if they match

OMG_DDS_API bool 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

OMG_DDS_API bool 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

OMG_DDS_API bool is_nil () const

Check if the InstanceHandle is nil.

Returns:

true if the InstanceHandle is nil

Public Static Functions

static OMG_DDS_API const InstanceHandle nil ()

Create an nil instance handle.

Returns:

a nil InstanceHandle