Class ParameterPropertyList_t

Nested Relationships

Nested Types

Inheritance Relationships

Base Type

Class Documentation

class ParameterPropertyList_t : public eprosima::fastdds::dds::Parameter_t

Public Functions

inline ParameterPropertyList_t()

Constructor without parameters Sets PID_PROPERTY_LIST as the PID of the parameter.

inline ParameterPropertyList_t(uint32_t size)

Constructor with a defined maximum size

Parameters:

size – Size to be set as maximum

inline ParameterPropertyList_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

inline ParameterPropertyList_t(const ParameterPropertyList_t &parameter_properties)

Constructor using a Parameter Property List.

Parameters:

parameter_properties – Properties to be set

inline ParameterPropertyList_t &operator=(const ParameterPropertyList_t &parameter_properties)
inline iterator begin()

Getter for the first position of the ParameterPropertyList.

Returns:

iterator

inline iterator end()

Getter for the end of the ParameterPropertyList.

Returns:

iterator

inline const_iterator begin() const

Getter for the first position of the ParameterPropertyList.

Returns:

const_iterator

inline const_iterator end() const

Getter for the end of the ParameterPropertyList.

Returns:

const_iterator

inline bool push_back(std::pair<std::string, std::string> p)

Introduce a new property in the ParameterPropertyList.

Parameters:

p – Pair with the values of the new property

Returns:

true if it is introduced, false if not.

inline bool push_back(const std::string &key, const std::string &value)

Introduce a new property in the ParameterPropertyList.

Parameters:

  • key – Key part of the new property

  • value – Value part of the new property

Returns:

true if it is introduced, false if not.

inline 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.

Parameters:

  • str1 – Name of the property

  • str1_size – Size of the first string

  • str2 – Value of the property

  • str2_size – Size of the second string

Returns:

true if it is introduced, false if not.

inline bool set_property(iterator pos, const std::pair<std::string, std::string> &new_value)

Setter of a new property value on a specific position.

Parameters:

  • pos – Iterator with the position of the property to be changed

  • new_value – Value to be set

Returns:

true if changed, false if not

inline void clear()

Clears the ParameterPropertyList.

inline uint32_t size() const

Getter for the size of the ParameterPropertyList.

Returns:

uint32_t with the size

inline void set_max_size(uint32_t size)

Setter for the maximum size of the ParameterPropertyList.

inline uint32_t max_size()

Getter for the maximum size of the ParameterPropertyList.

Returns:

uint32_t with the size

Protected Functions

inline void push_back_helper(const fastrtps::rtps::octet *data, uint32_t size, uint32_t alignment)
class const_iterator

Public Types

typedef const_iterator self_type
typedef const ParameterProperty_t value_type
typedef const ParameterProperty_t &reference
typedef const ParameterProperty_t *pointer
typedef size_t difference_type
typedef std::forward_iterator_tag iterator_category

Public Functions

inline const_iterator(const fastrtps::rtps::octet *ptr)

Constructor using a pointer.

Parameters:

ptr – Pointer to be set

inline self_type operator++()
inline self_type operator++(int)
inline reference operator*()
inline pointer operator->()
inline bool operator==(const self_type &rhs) const
inline bool operator!=(const self_type &rhs) const

Protected Functions

inline void advance()

Shift the pointer to the next value.

inline const fastrtps::rtps::octet *address() const

Getter for the pointer.

Returns:

the pointer

class iterator

Public Types

typedef iterator self_type
typedef ParameterProperty_t value_type
typedef ParameterProperty_t &reference
typedef ParameterProperty_t *pointer
typedef size_t difference_type
typedef std::forward_iterator_tag iterator_category

Public Functions

inline iterator(fastrtps::rtps::octet *ptr)

Constructor using an octet pointer.

Parameters:

ptr – Octet pointer to be set

inline self_type operator++()
inline self_type operator++(int)
inline reference operator*()
inline pointer operator->()
inline bool operator==(const self_type &rhs) const
inline bool operator!=(const self_type &rhs) const

Protected Functions

inline void advance()

Shift the pointer to the next value.

inline fastrtps::rtps::octet *address() const

Getter for the pointer.

Returns:

the pointer