Fast DDS  Version 3.1.2
Fast DDS
Loading...
Searching...
No Matches
InstanceHandle_t Struct Reference

Struct InstanceHandle_t, used to contain the key for WITH_KEY topics. More...

#include <InstanceHandle.hpp>

Public Member Functions

 InstanceHandle_t () noexcept=default
 
 InstanceHandle_t (const InstanceHandle_t &ihandle) noexcept=default
 
 InstanceHandle_t (const GUID_t &guid) noexcept
 
InstanceHandle_toperator= (const InstanceHandle_t &ihandle) noexcept=default
 Assignment operator.
 
InstanceHandle_toperator= (const GUID_t &guid) noexcept
 Assignment operator.
 
bool isDefined () const noexcept
 Know if the instance handle is defined.
 
void clear () noexcept
 
 operator const GUID_t & () const noexcept
 

Public Attributes

InstanceHandleValue_t value
 Value.
 

Detailed Description

Struct InstanceHandle_t, used to contain the key for WITH_KEY topics.

Constructor & Destructor Documentation

◆ InstanceHandle_t() [1/3]

InstanceHandle_t ( )
defaultnoexcept

◆ InstanceHandle_t() [2/3]

InstanceHandle_t ( const InstanceHandle_t ihandle)
defaultnoexcept

◆ InstanceHandle_t() [3/3]

InstanceHandle_t ( const GUID_t guid)
inlinenoexcept

Member Function Documentation

◆ clear()

void clear ( )
inlinenoexcept

◆ isDefined()

bool isDefined ( ) const
inlinenoexcept

Know if the instance handle is defined.

Returns
True if the values are not zero.

◆ operator const GUID_t &()

operator const GUID_t & ( ) const
inlineexplicitnoexcept

◆ operator=() [1/2]

InstanceHandle_t & operator= ( const GUID_t guid)
inlinenoexcept

Assignment operator.

Parameters
guidGUID to copy the data from

◆ operator=() [2/2]

InstanceHandle_t & operator= ( const InstanceHandle_t ihandle)
defaultnoexcept

Assignment operator.

Parameters
ihandleInstance handle to copy the data from

Member Data Documentation

◆ value

Value.


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