19#ifndef FASTDDS_DDS_CORE_POLICY__PARAMETERTYPES_HPP
20#define FASTDDS_DDS_CORE_POLICY__PARAMETERTYPES_HPP
22#ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
28#include <fastcdr/cdr/fixed_size_string.hpp>
30#include <fastdds/dds/core/Types.hpp>
31#include <fastdds/rtps/common/InstanceHandle.hpp>
32#include <fastdds/rtps/common/Locator.hpp>
33#include <fastdds/rtps/common/OriginalWriterInfo.hpp>
34#include <fastdds/rtps/common/ProductVersion_t.hpp>
35#include <fastdds/rtps/common/SampleIdentity.hpp>
36#include <fastdds/rtps/common/SerializedPayload.hpp>
37#include <fastdds/rtps/common/Time_t.hpp>
38#include <fastdds/rtps/common/Token.hpp>
41#include <fastdds/rtps/attributes/EndpointSecurityAttributes.hpp>
50struct ParticipantSecurityAttributes;
53typedef uint32_t PluginParticipantSecurityAttributesMask;
54typedef uint32_t ParticipantSecurityAttributesMask;
238 return (this->
Pid == b.
Pid) &&
297#define PARAMETER_KEY_HASH_LENGTH 16
346#define PARAMETER_LOCATOR_LENGTH 24
386 const fastcdr::string_255& strin)
399 return string_.c_str();
420 return string_.size();
426 fastcdr::string_255 string_;
479#define PARAMETER_PORT_LENGTH 4
545#define PARAMETER_GUID_LENGTH 16
582#define PARAMETER_DOMAINID_LENGTH 4
618#define PARAMETER_PROTOCOL_LENGTH 4
654#define PARAMETER_VENDOR_LENGTH 4
687#define PARAMETER_PRODUCT_VERSION_LENGTH 4
743#define PARAMETER_IP4_LENGTH 4
795#define PARAMETER_BOOL_LENGTH 4
847#define PARAMETER_STATUS_INFO_LENGTH 4
883#define PARAMETER_COUNT_LENGTH 4
919#define PARAMETER_ENTITYID_LENGTH 4
953#define PARAMETER_TIME_LENGTH 8
989#define PARAMETER_BUILTINENDPOINTSET_LENGTH 4
1025#define PARAMETER_NETWORKCONFIGSET_LENGTH 4
1069 return std::string((
char*)data + 4);
1080 uint32_t size1 = ParameterProperty_t::element_size(data);
1083 return std::string((
char*)data + size1 + 4);
1093 const std::pair<std::string, std::string>& new_value)
1095 uint32_t old_size =
size();
1097 uint32_t first_size = (uint32_t)new_value.first.size() + 1;
1098 uint32_t first_alignment = ((first_size + 3u) & ~3u) - first_size;
1099 uint32_t second_size = (uint32_t)new_value.second.size() + 1;
1100 uint32_t second_alignment = ((second_size + 3u) & ~3u) - second_size;
1101 uint32_t new_size = first_size + first_alignment + second_size + second_alignment + 8;
1103 if (old_size != new_size)
1109 memcpy(current, &first_size, 4);
1110 memcpy(current + 4, new_value.first.c_str(), first_size);
1111 memset(current + 4 + first_size, 0, first_alignment);
1113 current = data + 4 + first_size + first_alignment;
1114 memcpy(current, &second_size, 4);
1115 memcpy(current + 4, new_value.second.c_str(), second_size);
1116 memset(current + 4 + second_size, 0, second_alignment);
1126 std::pair<const std::string, const std::string>
pair()
const
1128 return std::make_pair(std::string(
first()), std::string(
second()));
1139 uint32_t size1 = ParameterProperty_t::element_size(data);
1142 uint32_t size2 = ParameterProperty_t::element_size(data + size1);
1143 return size1 + size2;
1156 return !(*
this == b);
1167 static uint32_t element_size(
1171 uint32_t
size = *(uint32_t*)ptr;
1172 return (4u + ((
size + 3u) & ~3u));
1257 uint32_t Nproperties_ = 0;
1259 bool limit_size_ =
false;
1313 return ptr_ == rhs.ptr_;
1319 return ptr_ != rhs.ptr_;
1329 ptr_ += value_.size();
1401 return ptr_ == rhs.ptr_;
1407 return ptr_ != rhs.ptr_;
1417 ptr_ += value_.size();
1448 , limit_size_ (false)
1462 , limit_size_ (
size == 0 ? false : true)
1477 , limit_size_ (false)
1479 static_cast<void>(pid);
1490 , properties_(parameter_properties.limit_size_ ?
1491 parameter_properties.properties_.
max_size :
1492 parameter_properties.properties_.
length)
1493 , Nproperties_ (parameter_properties.Nproperties_)
1494 , limit_size_ (parameter_properties.limit_size_)
1496 properties_.copy(¶meter_properties.properties_, parameter_properties.limit_size_);
1503 limit_size_ = parameter_properties.limit_size_;
1504 properties_.reserve(limit_size_ ?
1505 parameter_properties.properties_.
max_size :
1506 parameter_properties.properties_.
length);
1507 properties_.copy(¶meter_properties.properties_, parameter_properties.limit_size_);
1508 Nproperties_ = parameter_properties.Nproperties_;
1529 return iterator(properties_.data + properties_.length);
1559 std::pair<std::string, std::string> p)
1572 const std::string& key,
1573 const std::string& value)
1575 auto str1 =
reinterpret_cast<const unsigned char*
>(key.c_str());
1576 uint32_t size1 = (uint32_t) key.length() + 1;
1577 auto str2 =
reinterpret_cast<const unsigned char*
>(value.c_str());
1578 uint32_t size2 = (uint32_t) value.length() + 1;
1580 return push_back(str1, size1, str2, size2);
1593 const unsigned char* str1,
1595 const unsigned char* str2,
1599 uint32_t alignment1 = ((str1_size + 3u) & ~3u) - str1_size;
1600 uint32_t alignment2 = ((str2_size + 3u) & ~3u) - str2_size;
1602 if (limit_size_ && (properties_.max_size < properties_.length +
1603 str1_size + alignment1 + 4 +
1604 str2_size + alignment2 + 4))
1608 properties_.reserve(properties_.length +
1609 str1_size + alignment1 + 4 +
1610 str2_size + alignment2 + 4);
1627 const std::pair<std::string, std::string>& new_value)
1629 return pos->
modify(new_value);
1637 properties_.length = 0;
1648 return Nproperties_;
1657 properties_.reserve(
size);
1668 return (limit_size_ ? properties_.max_size : 0);
1679 memcpy(properties_.data + properties_.length, o, 4);
1680 properties_.length += 4;
1682 memcpy(properties_.data + properties_.length, data,
size);
1683 properties_.length +=
size;
1685 for (uint32_t i = 0; i < alignment; ++i)
1687 properties_.data[properties_.length + i] =
'\0';
1689 properties_.length += alignment;
1749#define PARAMETER_SAMPLEIDENTITY_LENGTH 24
1805#define PARAMETER_ORIGINALWRITERINFO_LENGTH 24
1813class ParameterToken_t :
public Parameter_t
1818 fastdds::rtps::Token token;
1836 : Parameter_t(pid, in_length)
1843#define PARAMETER_PARTICIPANT_SECURITY_INFO_LENGTH 8
1848class ParameterParticipantSecurityInfo_t :
public Parameter_t
1853 fastdds::rtps::security::ParticipantSecurityAttributesMask security_attributes = 0;
1855 fastdds::rtps::security::PluginParticipantSecurityAttributesMask plugin_security_attributes = 0;
1862 ParameterParticipantSecurityInfo_t()
1873 ParameterParticipantSecurityInfo_t(
1883#define PARAMETER_ENDPOINT_SECURITY_INFO_LENGTH 8
1888class ParameterEndpointSecurityInfo_t :
public Parameter_t
1892 fastdds::rtps::security::EndpointSecurityAttributesMask security_attributes = 0;
1893 fastdds::rtps::security::PluginEndpointSecurityAttributesMask plugin_security_attributes = 0;
1900 ParameterEndpointSecurityInfo_t()
1911 ParameterEndpointSecurityInfo_t(
1924template<
class T,
class PL>
1931 if (p == T::unknown())
1937 std::pair<std::string, std::string> pair;
1940 std::ostringstream data;
1942 pair.second = data.str();
1945 auto it = std::find_if(
1948 [&pair](
const typename PL::const_iterator::reference p)
1950 return pair.first == p.first();
1953 if (it != properties.end())
1956 properties.set_property(it, pair);
1961 properties.push_back(pair.first, pair.second);
1965template<
class T,
class PL>
1967 const char*
const PID,
1972 auto it = std::find_if(
1975 [PID](
const typename PL::const_iterator::reference p)
1977 return PID == p.first();
1980 if (it != properties.end())
1982 std::istringstream in(it->second());
2015using ParameterToken_t = fastdds::dds::ParameterToken_t;
2016using ParameterParticipantSecurityInfo_t = fastdds::dds::ParameterParticipantSecurityInfo_t;
2017using ParameterEndpointSecurityInfo_t = fastdds::dds::ParameterEndpointSecurityInfo_t;
Base Parameter class with parameter PID and parameter length in bytes.
Definition ParameterTypes.hpp:202
ParameterId_t Pid
Parameter ID. By default, PID_PAD.
Definition ParameterTypes.hpp:245
FASTDDS_EXPORTED_API Parameter_t()
Constructor without parameters.
Definition ParameterTypes.hpp:208
uint16_t length
Parameter length. By default, 0.
Definition ParameterTypes.hpp:247
FASTDDS_EXPORTED_API Parameter_t(ParameterId_t pid, uint16_t length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:220
virtual FASTDDS_EXPORTED_API ~Parameter_t()
Destructor.
Definition ParameterTypes.hpp:231
bool operator==(const Parameter_t &b) const
Definition ParameterTypes.hpp:235
Definition ParameterTypes.hpp:749
bool value
Boolean By default, false.
Definition ParameterTypes.hpp:753
ParameterBool_t()
Constructor without parameter.
Definition ParameterTypes.hpp:758
ParameterBool_t(ParameterId_t pid, uint16_t in_length, bool inbool)
Constructor using a parameter PID, the parameter length and a boolean.
Definition ParameterTypes.hpp:784
ParameterBool_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:769
Definition ParameterTypes.hpp:959
ParameterBuiltinEndpointSet_t()
Constructor without parameters.
Definition ParameterTypes.hpp:968
ParameterBuiltinEndpointSet_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:979
fastdds::rtps::BuiltinEndpointSet_t endpointSet
Builtin Endpoint Set By default, 0.
Definition ParameterTypes.hpp:963
Definition ParameterTypes.hpp:853
ParameterCount_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:873
fastdds::rtps::Count_t count
Count By default, 0.
Definition ParameterTypes.hpp:857
ParameterCount_t()
Constructor without parameter.
Definition ParameterTypes.hpp:862
Definition ParameterTypes.hpp:551
uint32_t domain_id
Domain ID. By default, DOMAIN_ID_UNKNOWN.
Definition ParameterTypes.hpp:555
ParameterDomainId_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:571
ParameterDomainId_t()
Constructor without parameters.
Definition ParameterTypes.hpp:560
Definition ParameterTypes.hpp:889
ParameterEntityId_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:909
ParameterEntityId_t()
Constructor without parameters.
Definition ParameterTypes.hpp:898
fastdds::rtps::EntityId_t entityId
EntityId By default, ENTITYID_UNKNOWN.
Definition ParameterTypes.hpp:893
Definition ParameterTypes.hpp:485
ParameterGuid_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:504
ParameterGuid_t(ParameterId_t pid, uint16_t in_length, const fastdds::rtps::InstanceHandle_t &iH)
Constructor using a parameter PID, the parameter length and a Instance Handle.
Definition ParameterTypes.hpp:534
fastdds::rtps::GUID_t guid
GUID By default, unknown GUID.
Definition ParameterTypes.hpp:489
ParameterGuid_t()
Constructor without parameters.
Definition ParameterTypes.hpp:494
ParameterGuid_t(ParameterId_t pid, uint16_t in_length, const fastdds::rtps::GUID_t &guidin)
Constructor using a parameter PID, the parameter length and a GUID.
Definition ParameterTypes.hpp:518
Definition ParameterTypes.hpp:693
ParameterIP4Address_t()
Constructor without parameters.
Definition ParameterTypes.hpp:702
ParameterIP4Address_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:713
fastdds::rtps::octet address[4]
Address By default [0,0,0,0].
Definition ParameterTypes.hpp:697
void setIP4Address(fastdds::rtps::octet o1, fastdds::rtps::octet o2, fastdds::rtps::octet o3, fastdds::rtps::octet o4)
Setter for the address.
Definition ParameterTypes.hpp:729
Definition ParameterTypes.hpp:254
ParameterKey_t()
Constructor without parameters.
Definition ParameterTypes.hpp:262
ParameterKey_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:272
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.
Definition ParameterTypes.hpp:286
fastdds::rtps::InstanceHandle_t key
Instance Handle. By default, c_InstanceHandle_Unknown.
Definition ParameterTypes.hpp:258
Definition ParameterTypes.hpp:303
ParameterLocator_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:322
rtps::Locator locator
Locator.
Definition ParameterTypes.hpp:307
ParameterLocator_t(ParameterId_t pid, uint16_t in_length, const rtps::Locator &loc)
Constructor using a parameter PID, the parameter length and a Locator.
Definition ParameterTypes.hpp:336
ParameterLocator_t()
Constructor without parameters.
Definition ParameterTypes.hpp:312
Definition ParameterTypes.hpp:995
fastdds::rtps::NetworkConfigSet_t netconfigSet
Network Config Set By default, 0.
Definition ParameterTypes.hpp:999
ParameterNetworkConfigSet_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:1015
ParameterNetworkConfigSet_t()
Constructor without parameters.
Definition ParameterTypes.hpp:1004
ParameterOriginalWriterInfo_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:1775
fastdds::rtps::OriginalWriterInfo original_writer_info
Original Writer Info By default, unknown.
Definition ParameterTypes.hpp:1759
bool addToCDRMessage(fastdds::rtps::CDRMessage_t *msg) const
Add the parameter to a CDRMessage_t message.
bool readFromCDRMessage(fastdds::rtps::CDRMessage_t *msg, uint16_t size)
Read the parameter from a CDRMessage_t message.
ParameterOriginalWriterInfo_t()
Constructor without parameters.
Definition ParameterTypes.hpp:1764
Definition ParameterTypes.hpp:433
uint32_t port
Port. By default, 0.
Definition ParameterTypes.hpp:437
ParameterPort_t(ParameterId_t pid, uint16_t in_length, uint32_t po)
Constructor using a parameter PID, the parameter length and a port.
Definition ParameterTypes.hpp:468
ParameterPort_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:453
ParameterPort_t()
Constructor without parameters.
Definition ParameterTypes.hpp:442
Definition ParameterTypes.hpp:660
ParameterProductVersion_t()
Constructor without parameters.
Definition ParameterTypes.hpp:668
rtps::ProductVersion_t version
Definition ParameterTypes.hpp:663
ParameterProductVersion_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:678
Definition ParameterTypes.hpp:1031
std::string second() const
Getter for the second element in data.
Definition ParameterTypes.hpp:1077
ParameterProperty_t()
Constructor without parameters.
Definition ParameterTypes.hpp:1045
uint32_t size() const
Getter for data size.
Definition ParameterTypes.hpp:1136
bool modify(const std::pair< std::string, std::string > &new_value)
Setter using a pair of strings.
Definition ParameterTypes.hpp:1092
bool operator==(const ParameterProperty_t &b) const
Definition ParameterTypes.hpp:1146
friend class ParameterPropertyList_t
Definition ParameterTypes.hpp:1033
ParameterProperty_t(void *ptr)
Constructor using a pointer.
Definition ParameterTypes.hpp:1055
std::string first() const
Getter for the first element in data.
Definition ParameterTypes.hpp:1066
std::pair< const std::string, const std::string > pair() const
Getter that returns a pair of the first and second elements in data.
Definition ParameterTypes.hpp:1126
bool operator!=(const ParameterProperty_t &b) const
Definition ParameterTypes.hpp:1153
Definition ParameterTypes.hpp:1352
const fastdds::rtps::octet * address() const
Getter for the pointer.
Definition ParameterTypes.hpp:1426
pointer operator->()
Definition ParameterTypes.hpp:1393
size_t difference_type
Definition ParameterTypes.hpp:1359
self_type operator++()
Definition ParameterTypes.hpp:1374
bool operator==(const self_type &rhs) const
Definition ParameterTypes.hpp:1398
std::forward_iterator_tag iterator_category
Definition ParameterTypes.hpp:1360
bool operator!=(const self_type &rhs) const
Definition ParameterTypes.hpp:1404
reference operator*()
Definition ParameterTypes.hpp:1388
const_iterator self_type
Definition ParameterTypes.hpp:1355
const_iterator(const fastdds::rtps::octet *ptr)
Constructor using a pointer.
Definition ParameterTypes.hpp:1367
void advance()
Shift the pointer to the next value.
Definition ParameterTypes.hpp:1415
const ParameterProperty_t * pointer
Definition ParameterTypes.hpp:1358
const ParameterProperty_t value_type
Definition ParameterTypes.hpp:1356
const ParameterProperty_t & reference
Definition ParameterTypes.hpp:1357
Definition ParameterTypes.hpp:1264
fastdds::rtps::octet * address() const
Getter for the pointer.
Definition ParameterTypes.hpp:1338
ParameterProperty_t value_type
Definition ParameterTypes.hpp:1268
pointer operator->()
Definition ParameterTypes.hpp:1305
size_t difference_type
Definition ParameterTypes.hpp:1271
self_type operator++()
Definition ParameterTypes.hpp:1286
bool operator==(const self_type &rhs) const
Definition ParameterTypes.hpp:1310
std::forward_iterator_tag iterator_category
Definition ParameterTypes.hpp:1272
ParameterProperty_t * pointer
Definition ParameterTypes.hpp:1270
bool operator!=(const self_type &rhs) const
Definition ParameterTypes.hpp:1316
reference operator*()
Definition ParameterTypes.hpp:1300
void advance()
Shift the pointer to the next value.
Definition ParameterTypes.hpp:1327
ParameterProperty_t & reference
Definition ParameterTypes.hpp:1269
iterator(fastdds::rtps::octet *ptr)
Constructor using an octet pointer.
Definition ParameterTypes.hpp:1279
iterator self_type
Definition ParameterTypes.hpp:1267
Definition ParameterTypes.hpp:1251
ParameterPropertyList_t(const ParameterPropertyList_t ¶meter_properties)
Constructor using a Parameter Property List.
Definition ParameterTypes.hpp:1487
const_iterator begin() const
Getter for the first position of the ParameterPropertyList.
Definition ParameterTypes.hpp:1537
bool push_back(std::pair< std::string, std::string > p)
Introduce a new property in the ParameterPropertyList.
Definition ParameterTypes.hpp:1558
ParameterPropertyList_t & operator=(const ParameterPropertyList_t ¶meter_properties)
Definition ParameterTypes.hpp:1499
void push_back_helper(const fastdds::rtps::octet *data, uint32_t size, uint32_t alignment)
Definition ParameterTypes.hpp:1673
uint32_t max_size()
Getter for the maximum size of the ParameterPropertyList.
Definition ParameterTypes.hpp:1666
ParameterPropertyList_t(uint32_t size)
Constructor with a defined maximum size.
Definition ParameterTypes.hpp:1457
bool set_property(iterator pos, const std::pair< std::string, std::string > &new_value)
Setter of a new property value on a specific position.
Definition ParameterTypes.hpp:1625
uint32_t size() const
Getter for the size of the ParameterPropertyList.
Definition ParameterTypes.hpp:1646
bool push_back(const unsigned char *str1, uint32_t str1_size, const unsigned char *str2, uint32_t str2_size)
Introduce a new property in the ParameterPropertyList.
Definition ParameterTypes.hpp:1592
ParameterPropertyList_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:1472
void set_max_size(uint32_t size)
Setter for the maximum size of the ParameterPropertyList.
Definition ParameterTypes.hpp:1654
bool push_back(const std::string &key, const std::string &value)
Introduce a new property in the ParameterPropertyList.
Definition ParameterTypes.hpp:1571
void clear()
Clears the ParameterPropertyList.
Definition ParameterTypes.hpp:1635
iterator end()
Getter for the end of the ParameterPropertyList.
Definition ParameterTypes.hpp:1527
const_iterator end() const
Getter for the end of the ParameterPropertyList.
Definition ParameterTypes.hpp:1547
iterator begin()
Getter for the first position of the ParameterPropertyList.
Definition ParameterTypes.hpp:1517
ParameterPropertyList_t()
Constructor without parameters Sets PID_PROPERTY_LIST as the PID of the parameter.
Definition ParameterTypes.hpp:1445
Definition ParameterTypes.hpp:588
ParameterProtocolVersion_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:608
fastdds::rtps::ProtocolVersion_t protocolVersion
Protocol Version. By default, c_ProtocolVersion.
Definition ParameterTypes.hpp:592
ParameterProtocolVersion_t()
Constructor without parameters.
Definition ParameterTypes.hpp:597
Definition ParameterTypes.hpp:1699
ParameterSampleIdentity_t()
Constructor without parameters.
Definition ParameterTypes.hpp:1708
bool addToCDRMessage(fastdds::rtps::CDRMessage_t *msg) const
Add the parameter to a CDRMessage_t message.
bool readFromCDRMessage(fastdds::rtps::CDRMessage_t *msg, uint16_t size)
Read the parameter from a CDRMessage_t message.
ParameterSampleIdentity_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:1719
fastdds::rtps::SampleIdentity sample_id
Sample Identity By default, unknown.
Definition ParameterTypes.hpp:1703
Definition ParameterTypes.hpp:801
ParameterStatusInfo_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:821
ParameterStatusInfo_t(ParameterId_t pid, uint16_t in_length, uint8_t instatus)
Constructor using a parameter PID, the parameter length and status value.
Definition ParameterTypes.hpp:836
ParameterStatusInfo_t()
Constructor without parameter.
Definition ParameterTypes.hpp:810
uint8_t status
Status By default, 0.
Definition ParameterTypes.hpp:805
Definition ParameterTypes.hpp:353
size_t size() const
Getter for the name size.
Definition ParameterTypes.hpp:418
const char * getName() const
Getter for the name.
Definition ParameterTypes.hpp:397
ParameterString_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:369
ParameterString_t(ParameterId_t pid, uint16_t in_length, const fastcdr::string_255 &strin)
Constructor using a parameter PID, the parameter length and a string.
Definition ParameterTypes.hpp:383
void setName(const char *name)
Setter for the name.
Definition ParameterTypes.hpp:407
ParameterString_t()
Constructor without parameters.
Definition ParameterTypes.hpp:359
Definition ParameterTypes.hpp:925
fastdds::rtps::Time_t time
Time By default, 0.
Definition ParameterTypes.hpp:929
ParameterTime_t()
Constructor without parameters.
Definition ParameterTypes.hpp:934
ParameterTime_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:944
Definition ParameterTypes.hpp:624
ParameterVendorId_t()
Constructor without parameters.
Definition ParameterTypes.hpp:633
fastdds::rtps::VendorId_t vendorId
Vendor Id. By default, c_VendorId_eProsima.
Definition ParameterTypes.hpp:628
ParameterVendorId_t(ParameterId_t pid, uint16_t in_length)
Constructor using a parameter PID and the parameter length.
Definition ParameterTypes.hpp:644
Definition OriginalWriterInfo.hpp:31
This class is used to specify a sample.
Definition SampleIdentity.hpp:34
Structure Time_t, used to describe times at RTPS protocol.
Definition Time_t.hpp:38
const std::string parameter_property_participant_type
Parameter property ID for participant type.
Definition ParameterTypes.hpp:1189
const char *const parameter_enable_monitor_service
Parameter property value for enabling the monitor service.
Definition ParameterTypes.hpp:1231
const char *const parameter_policy_type_propagation
Parameter property value for configuring type propagation.
Definition ParameterTypes.hpp:1238
ParameterId_t
Enum for the unique parameter identifier.
Definition ParameterTypes.hpp:70
const std::string parameter_property_persistence_guid
Parameter property ID for persistence GUID.
Definition ParameterTypes.hpp:1182
const std::string parameter_property_ds_version
Parameter property ID for Discovery Server version.
Definition ParameterTypes.hpp:1196
const char *const parameter_policy_physical_data_host
Parameter property value for Host physical data.
Definition ParameterTypes.hpp:1210
const std::string parameter_property_current_ds_version
Parameter property value for Discovery Server version.
Definition ParameterTypes.hpp:1203
const char *const parameter_policy_physical_data_process
Parameter property value for Process physical data.
Definition ParameterTypes.hpp:1224
const char *const parameter_serialize_optional_qos
Parameter property value for configuring serialization of optional QoS in Data(r/w).
Definition ParameterTypes.hpp:1245
const char *const parameter_policy_physical_data_user
Parameter property value for User physical data.
Definition ParameterTypes.hpp:1217
@ PID_TOPIC_NAME
Definition ParameterTypes.hpp:75
@ PID_SENTINEL
Definition ParameterTypes.hpp:73
@ PID_TOPIC_DATA
Definition ParameterTypes.hpp:78
@ PID_GROUP_SEQ_NUM
Definition ParameterTypes.hpp:125
@ PID_PARTICIPANT_MANUAL_LIVELINESS_COUNT
Definition ParameterTypes.hpp:106
@ PID_DURABILITY_SERVICE
Definition ParameterTypes.hpp:80
@ PID_UNICAST_LOCATOR
Definition ParameterTypes.hpp:99
@ PID_LIVELINESS
Definition ParameterTypes.hpp:83
@ PID_OWNERSHIP
Definition ParameterTypes.hpp:89
@ PID_EXPECTS_INLINE_QOS
Definition ParameterTypes.hpp:105
@ PID_COHERENT_SET
Definition ParameterTypes.hpp:121
@ PID_LATENCY_BUDGET
Definition ParameterTypes.hpp:82
@ PID_RESOURCE_LIMITS
Definition ParameterTypes.hpp:88
@ PID_GROUP_GUID
Definition ParameterTypes.hpp:110
@ PID_TYPE_MAX_SIZE_SERIALIZED
Definition ParameterTypes.hpp:115
@ PID_SERVICE_INSTANCE_NAME
Definition ParameterTypes.hpp:164
@ PID_DATASHARING
Definition ParameterTypes.hpp:174
@ PID_PROTOCOL_VERSION
Definition ParameterTypes.hpp:97
@ PID_RPC_MORE_REPLIES
Definition ParameterTypes.hpp:190
@ PID_READER_DATA_LIFECYCLE
Definition ParameterTypes.hpp:184
@ PID_BUILTIN_ENDPOINT_SET
Definition ParameterTypes.hpp:112
@ PID_PAD
Definition ParameterTypes.hpp:72
@ PID_WRITER_GROUP_INFO
Definition ParameterTypes.hpp:126
@ PID_READER_RESOURCE_LIMITS
Definition ParameterTypes.hpp:186
@ PID_PUBLISH_MODE
Definition ParameterTypes.hpp:180
@ PID_RELIABILITY
Definition ParameterTypes.hpp:84
@ PID_VENDORID
Definition ParameterTypes.hpp:98
@ PID_PARTICIPANT_SECURITY_INFO
Definition ParameterTypes.hpp:152
@ PID_CONTENT_FILTER_INFO
Definition ParameterTypes.hpp:120
@ PID_TOPIC_ALIASES
Definition ParameterTypes.hpp:166
@ PID_DURABILITY
Definition ParameterTypes.hpp:79
@ PID_METATRAFFIC_MULTICAST_LOCATOR
Definition ParameterTypes.hpp:104
@ PID_PROPERTY_LIST
Definition ParameterTypes.hpp:114
@ PID_USER_DATA
Definition ParameterTypes.hpp:74
@ PID_DIRECTED_WRITE
Definition ParameterTypes.hpp:122
@ PID_ORIGINAL_WRITER_INFO
Definition ParameterTypes.hpp:123
@ PID_BUILTIN_ENDPOINT_QOS
Definition ParameterTypes.hpp:113
@ PID_DEFAULT_MULTICAST_LOCATOR
Definition ParameterTypes.hpp:102
@ PID_DEADLINE
Definition ParameterTypes.hpp:81
@ PID_RELATED_ENTITY_GUID
Definition ParameterTypes.hpp:165
@ PID_WRITER_DATA_LIFECYCLE
Definition ParameterTypes.hpp:179
@ PID_TYPE_IDV1
Definition ParameterTypes.hpp:143
@ PID_IDENTITY_TOKEN
Definition ParameterTypes.hpp:150
@ PID_PARTICIPANT_GUID
Definition ParameterTypes.hpp:109
@ PID_TYPE_INFORMATION
Definition ParameterTypes.hpp:147
@ PID_SAFE_DDS_SIGNATURE
Definition ParameterTypes.hpp:193
@ PID_IDENTITY_STATUS_TOKEN
Definition ParameterTypes.hpp:158
@ PID_DESTINATION_ORDER
Definition ParameterTypes.hpp:86
@ PID_MULTICAST_LOCATOR
Definition ParameterTypes.hpp:100
@ PID_GROUP_ENTITYID
Definition ParameterTypes.hpp:111
@ PID_KEY_HASH
Definition ParameterTypes.hpp:128
@ PID_PRESENTATION
Definition ParameterTypes.hpp:91
@ PID_RELATED_SAMPLE_IDENTITY
Definition ParameterTypes.hpp:167
@ PID_NETWORK_CONFIGURATION_SET
Definition ParameterTypes.hpp:175
@ PID_LIFESPAN
Definition ParameterTypes.hpp:85
@ PID_DISABLE_POSITIVE_ACKS
Definition ParameterTypes.hpp:173
@ PID_TYPE_CONSISTENCY_ENFORCEMENT
Definition ParameterTypes.hpp:146
@ PID_RTPS_RELIABLE_WRITER
Definition ParameterTypes.hpp:181
@ PID_CUSTOM_RELATED_SAMPLE_IDENTITY
Definition ParameterTypes.hpp:176
@ PID_OWNERSHIP_STRENGTH
Definition ParameterTypes.hpp:90
@ PID_WRITER_RESOURCE_LIMITS
Definition ParameterTypes.hpp:182
@ PID_ENDPOINT_GUID
Definition ParameterTypes.hpp:117
@ PID_PARTITION
Definition ParameterTypes.hpp:92
@ PID_DATA_TAGS
Definition ParameterTypes.hpp:161
@ PID_ENTITY_NAME
Definition ParameterTypes.hpp:116
@ PID_DEFAULT_UNICAST_LOCATOR
Definition ParameterTypes.hpp:101
@ PID_TRANSPORT_PRIORITY
Definition ParameterTypes.hpp:94
@ PID_METATRAFFIC_UNICAST_LOCATOR
Definition ParameterTypes.hpp:103
@ PID_PARTICIPANT_LEASE_DURATION
Definition ParameterTypes.hpp:107
@ PID_CONTENT_FILTER_PROPERTY
Definition ParameterTypes.hpp:108
@ PID_STATUS_INFO
Definition ParameterTypes.hpp:129
@ PID_TIME_BASED_FILTER
Definition ParameterTypes.hpp:93
@ PID_GROUP_COHERENT_SET
Definition ParameterTypes.hpp:124
@ PID_GROUP_DATA
Definition ParameterTypes.hpp:77
@ PID_WIREPROTOCOL_CONFIG
Definition ParameterTypes.hpp:188
@ PID_PRODUCT_VERSION
Definition ParameterTypes.hpp:170
@ PID_ENDPOINT_SECURITY_INFO
Definition ParameterTypes.hpp:155
@ PID_RTPS_RELIABLE_READER
Definition ParameterTypes.hpp:185
@ PID_RTPS_ENDPOINT
Definition ParameterTypes.hpp:177
@ PID_SECURE_WRITER_GROUP_INFO
Definition ParameterTypes.hpp:127
@ PID_HISTORY
Definition ParameterTypes.hpp:87
@ PID_TYPE_OBJECTV1
Definition ParameterTypes.hpp:144
@ PID_DOMAIN_ID
Definition ParameterTypes.hpp:95
@ PID_PERSISTENCE_GUID
Definition ParameterTypes.hpp:171
@ PID_DOMAIN_TAG
Definition ParameterTypes.hpp:96
@ PID_MACHINE_ID
Definition ParameterTypes.hpp:172
@ PID_PERMISSIONS_TOKEN
Definition ParameterTypes.hpp:151
@ PID_DATA_REPRESENTATION
Definition ParameterTypes.hpp:145
@ PID_TYPE_NAME
Definition ParameterTypes.hpp:76
Definition BuiltinTopicKey.hpp:26
const DomainId_t DOMAIN_ID_UNKNOWN
Definition Types.hpp:26
void set_proxy_property(const T &p, const char *PID, PL &properties)
Definition ParameterTypes.hpp:1925
T get_proxy_property(const char *const PID, PL &properties)
Definition ParameterTypes.hpp:1966
Definition EndpointSecurityAttributes.hpp:26
uint32_t PluginEndpointSecurityAttributesMask
Definition EndpointSecurityAttributes.hpp:28
uint32_t EndpointSecurityAttributesMask
Definition EndpointSecurityAttributes.hpp:63
Contains the RTPS protocol implementation.
uint32_t BuiltinEndpointSet_t
Definition Types.hpp:85
fastdds::dds::ParameterNetworkConfigSet_t ParameterNetworkConfigSet_t
Definition ParameterTypes.hpp:2011
fastdds::dds::ParameterProtocolVersion_t ParameterProtocolVersion_t
Definition ParameterTypes.hpp:2001
fastdds::dds::ParameterGuid_t ParameterGuid_t
Definition ParameterTypes.hpp:1999
fastdds::dds::ParameterTime_t ParameterTime_t
Definition ParameterTypes.hpp:2009
fastdds::dds::ParameterIP4Address_t ParameterIP4Address_t
Definition ParameterTypes.hpp:2004
fastdds::dds::ParameterStatusInfo_t ParameterStatusInfo_t
Definition ParameterTypes.hpp:2006
fastdds::dds::ParameterLocator_t ParameterLocator_t
Definition ParameterTypes.hpp:1996
std::array< uint8_t, 2 > VendorId_t
Structure VendorId_t, specifying the vendor Id of the implementation.
Definition VendorId_t.hpp:32
fastdds::dds::ParameterId_t ParameterId_t
Definition ParameterTypes.hpp:1993
fastdds::dds::ParameterDomainId_t ParameterDomainId_t
Definition ParameterTypes.hpp:2000
uint32_t Count_t
Definition Types.hpp:87
fastdds::dds::ParameterBool_t ParameterBool_t
Definition ParameterTypes.hpp:2005
const ProtocolVersion_t c_ProtocolVersion
Definition Types.hpp:161
fastdds::dds::ParameterKey_t ParameterKey_t
Definition ParameterTypes.hpp:1995
uint8_t octet
Definition Types.hpp:83
fastdds::dds::Parameter_t Parameter_t
Definition ParameterTypes.hpp:1994
fastdds::dds::ParameterProductVersion_t ParameterProductVersion_t
Definition ParameterTypes.hpp:2003
void iHandle2GUID(GUID_t &guid, const InstanceHandle_t &ihandle) noexcept
Convert InstanceHandle_t to GUID.
Definition InstanceHandle.hpp:249
fastdds::dds::ParameterPort_t ParameterPort_t
Definition ParameterTypes.hpp:1998
fastdds::dds::ParameterCount_t ParameterCount_t
Definition ParameterTypes.hpp:2007
uint32_t NetworkConfigSet_t
Definition Types.hpp:86
fastdds::dds::ParameterVendorId_t ParameterVendorId_t
Definition ParameterTypes.hpp:2002
fastdds::dds::ParameterString_t ParameterString_t
Definition ParameterTypes.hpp:1997
fastdds::dds::ParameterBuiltinEndpointSet_t ParameterBuiltinEndpointSet_t
Definition ParameterTypes.hpp:2010
eprosima::fastdds::rtps::Locator_t Locator
Definition Locator.hpp:572
fastdds::dds::ParameterEntityId_t ParameterEntityId_t
Definition ParameterTypes.hpp:2008
fastdds::dds::ParameterSampleIdentity_t ParameterSampleIdentity_t
Definition ParameterTypes.hpp:2013
fastdds::dds::ParameterPropertyList_t ParameterPropertyList_t
Definition ParameterTypes.hpp:2012
Structure CDRMessage_t, contains a serialized message.
Definition CDRMessage_t.hpp:51
Structure EntityId_t, entity id part of GUID_t.
Definition EntityId_t.hpp:77
Structure GUID_t, entity identifier, unique in DDS-RTPS Domain.
Definition Guid.hpp:40
Struct InstanceHandle_t, used to contain the key for WITH_KEY topics.
Definition InstanceHandle.hpp:154
Definition ProductVersion_t.hpp:31
Structure ProtocolVersion_t, contains the protocol version.
Definition Types.hpp:102
Structure SerializedPayload_t.
Definition SerializedPayload.hpp:59
uint32_t max_size
Maximum size of the payload.
Definition SerializedPayload.hpp:70
uint32_t length
Actual length of the data.
Definition SerializedPayload.hpp:66