RTI Connext Modern C++ API  Version 5.2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
dds::core::InstanceHandle Class Reference

<<value-type>> Handle to identiy 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.
 
bool operator== (const dds::core::null_type &other) const
 Returns is_nil()
 
bool is_nil () const
 Check if this InstanceHandle represents the nil InstanceHandle.
 

Static Public Member Functions

static const InstanceHandle nil ()
 Returns the nil instance handle.
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const dds::core::InstanceHandle &h)
 Prints an instance handle.
 

Detailed Description

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

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

See Also
dds::pub::DataWriter::register_instance
dds::sub::SampleInfo::instance_handle
dds::pub::DataWriter::register_instance
dds::sub::SampleInfo::instance_handle

Constructor & Destructor Documentation

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

Create a nil instance handle.

Member Function Documentation

bool dds::core::InstanceHandle::operator== ( const dds::core::null_type other) const
inline

Returns is_nil()

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

Returns the nil instance handle.

Special dds::core::InstanceHandle value

See Also
dds::core::InstanceHandle::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

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.

RTI Connext Modern C++ API Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc