Fast DDS  Version 3.1.0
Fast DDS
Loading...
Searching...
No Matches
ParameterKey_t Class Reference

#include <ParameterTypes.hpp>

Inheritance diagram for ParameterKey_t:

Public Member Functions

 ParameterKey_t ()
 Constructor without parameters.
 
 ParameterKey_t (ParameterId_t pid, uint16_t in_length)
 Constructor using a parameter PID and the parameter length.
 
 ParameterKey_t (ParameterId_t pid, uint16_t in_length, const fastdds::rtps::InstanceHandle_t &ke)
 Constructor using a parameter PID, parameter length and Instance Handle.
 
- Public Member Functions inherited from Parameter_t
FASTDDS_EXPORTED_API Parameter_t ()
 Constructor without parameters.
 
FASTDDS_EXPORTED_API Parameter_t (ParameterId_t pid, uint16_t length)
 Constructor using a parameter PID and the parameter length.
 
virtual FASTDDS_EXPORTED_API ~Parameter_t ()
 Destructor.
 
bool operator== (const Parameter_t &b) const
 

Public Attributes

fastdds::rtps::InstanceHandle_t key
 Instance Handle.
By default, c_InstanceHandle_Unknown.
 
- Public Attributes inherited from Parameter_t
ParameterId_t Pid
 Parameter ID.
By default, PID_PAD.
 
uint16_t length
 Parameter length.
By default, 0.
 

Constructor & Destructor Documentation

◆ ParameterKey_t() [1/3]

ParameterKey_t ( )
inline

Constructor without parameters.

◆ ParameterKey_t() [2/3]

ParameterKey_t ( ParameterId_t  pid,
uint16_t  in_length 
)
inline

Constructor using a parameter PID and the parameter length.

Parameters
pidPid of the parameter
in_lengthIts associated length

◆ ParameterKey_t() [3/3]

ParameterKey_t ( ParameterId_t  pid,
uint16_t  in_length,
const fastdds::rtps::InstanceHandle_t ke 
)
inline

Constructor using a parameter PID, parameter length and Instance Handle.

Parameters
pidPid of the parameter
in_lengthIts associated length
keInstance Handle to be set

Member Data Documentation

◆ key

Instance Handle.
By default, c_InstanceHandle_Unknown.


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