dds::core::InstanceHandle Class Reference

<<value-type>> Handle to identify different instances of the same dds::topic::Topic of a certain type. More...

#include <dds/core/InstanceHandle.hpp>

Public Member Functions
	InstanceHandle (const dds::core::null_type &null_handle)
	Create a nil instance handle. More...
bool	operator== (const dds::core::null_type &) const
	Returns is_nil() More...
bool	is_nil () const
	Check if this InstanceHandle represents the nil InstanceHandle. More...

Static Public Member Functions
static InstanceHandle	nil ()
	Returns the nil instance handle. More...

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &os, const dds::core::InstanceHandle &h)
	Prints an instance handle. More...

Detailed Description

<<value-type>> Handle to identify different instances of the same dds::topic::Topic of a certain type.

Handle to identify different instances of the same dds::topic::Topic of a certain type.

See also

dds::pub::DataWriter::register_instance

dds::sub::SampleInfo::instance_handle

Note

A specialization of std::hash for InstanceHandle is defined.

See also

dds::pub::DataWriter::register_instance

dds::sub::SampleInfo::instance_handle

Constructor & Destructor Documentation

InstanceHandle()

dds::core::InstanceHandle::InstanceHandle ( const dds::core::null_type &  null_handle )

inline

Create a nil instance handle.

Member Function Documentation

operator==()

bool dds::core::InstanceHandle::operator== ( const dds::core::null_type &  ) const

inline

Returns is_nil()

nil()

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

inlinestatic

Returns the nil instance handle.

Special dds::core::InstanceHandle value

See also

dds::core::InstanceHandle::is_nil

is_nil()

bool dds::core::InstanceHandle::is_nil ( ) const

inline

Check if this InstanceHandle represents the nil InstanceHandle.

Returns

true if the InstanceHandle is nil, false otherwise

Friends And Related Function Documentation

operator<<()

std::ostream & operator<< ( std::ostream &  os, const dds::core::InstanceHandle &  h  )

related

Prints an instance handle.

The format is 16 2-digit contiguous hexadecimal numbers, for example:

0000004d000000000000000000000000

Examples

Foo.hpp.