Template Struct DynamicParameter

Struct Documentation

template<typename T>
struct DynamicParameter

Public Functions

inline DynamicParameter(const T &defaultValue, const std::string &descriptionText)

Initialization constructor.

Parameters:

  • defaultValue – [in] Default value to be set for parameter.

  • descriptionText – [in] Description to be set.

inline DynamicParameter(const int &defaultValue, const std::string &descriptionText, const int &min, const int &max, const int &step = 0)

Initialization constructor for bounded integer parameters.

Parameters:

  • defaultValue – [in] Default value to be set for parameter.

  • descriptionText – [in] Description to be set.

  • min – [in] Minimum value (inclusive)

  • max – [in] Maximum value (inclusive)

  • step – [in] Step between min and max. If left with 0, a continuous range is assumed.

inline DynamicParameter(const double &defaultValue, const std::string &descriptionText, const double &min, const double &max, const double &step = 0.0)

Initialization constructor for bounded floating point parameters.

Parameters:

  • defaultValue – [in] Default value to be set for parameter.

  • descriptionText – [in] Description to be set.

  • min – [in] Minimum value (inclusive)

  • max – [in] Maximum value (inclusive)

  • step – [in] Step between min and max. If left with 0, a continuous range is assumed.

inline bool setValue(const rclcpp::Parameter &iParameter)

Set value from rclcpp::Parameter.

Returns:

True, if successful. False, otherwise.

Public Members

T value
rcl_interfaces::msg::ParameterDescriptor desc