Class ParameterSampleIdentity_t

Inheritance Relationships

Base Type

Class Documentation

class ParameterSampleIdentity_t : public eprosima::fastdds::dds::Parameter_t

Public Functions

inline ParameterSampleIdentity_t()

Constructor without parameters.

inline ParameterSampleIdentity_t(ParameterId_t pid, uint16_t in_length)

Constructor using a parameter PID and the parameter length

Parameters:

  • pid – Pid of the parameter

  • in_length – Its associated length

bool addToCDRMessage(fastrtps::rtps::CDRMessage_t *msg) const

Add the parameter to a CDRMessage_t message.

Parameters:

msg – [inout] Pointer to the message where the parameter should be added.

Returns:

True if the parameter was correctly added.

bool readFromCDRMessage(fastrtps::rtps::CDRMessage_t *msg, uint16_t size)

Read the parameter from a CDRMessage_t message.

Parameters:

  • msg – [inout] Pointer to the message from where the parameter should be taken.

  • size – Size of the parameter field to read

Returns:

True if the parameter was correctly taken.

Public Members

fastrtps::rtps::SampleIdentity sample_id

Sample Identity

By default, unknown.