moveit_servo::ParameterDescriptorBuilder Class Reference

#include <parameter_descriptor_builder.hpp>

Public Member Functions
	operator rcl_interfaces::msg::ParameterDescriptor () const
	Rcl_interfaces::msg::parameterdescriptor conversion operator. More...
ParameterDescriptorBuilder &	type (uint8_t type)
	Set the type. More...
ParameterDescriptorBuilder &	description (const std::string &description)
	Set the description string. More...
ParameterDescriptorBuilder &	additionalConstraints (const std::string &additional_constraints)
	Set the additional constraints string (a description of any additional constraints which cannot be expressed with the available parameter constraints) More...
ParameterDescriptorBuilder &	readOnly (bool read_only)
	Sets the read only flag. More...
ParameterDescriptorBuilder &	dynamicTyping (bool dynamic_typing)
	Set the dynamic typing flag (rolling only) More...
ParameterDescriptorBuilder &	floatingPointRange (double from_value=std::numeric_limits< double >::min(), double to_value=std::numeric_limits< double >::max(), double step=0)
	Set floating point range. More...
ParameterDescriptorBuilder &	integerRange (int64_t from_value=std::numeric_limits< int64_t >::min(), int64_t to_value=std::numeric_limits< int64_t >::max(), int64_t step=0)
	Set the integer range. More...

Detailed Description

Definition at line 48 of file parameter_descriptor_builder.hpp.

Member Function Documentation

additionalConstraints()

ParameterDescriptorBuilder & moveit_servo::ParameterDescriptorBuilder::additionalConstraints

(

const std::string &

additional_constraints

)

Set the additional constraints string (a description of any additional constraints which cannot be expressed with the available parameter constraints)

Parameters

[in]

additional_constraints

The additional constraints

Returns

Reference to this object

Definition at line 51 of file parameter_descriptor_builder.cpp.

description()

ParameterDescriptorBuilder & moveit_servo::ParameterDescriptorBuilder::description

(

const std::string &

description

)

Set the description string.

Parameters

[in]

description

The description

Returns

Reference to this object

Definition at line 45 of file parameter_descriptor_builder.cpp.

dynamicTyping()

ParameterDescriptorBuilder & moveit_servo::ParameterDescriptorBuilder::dynamicTyping

(

bool

dynamic_typing

)

Set the dynamic typing flag (rolling only)

Parameters

[in]

dynamic_typing

The dynamic typing flag

Returns

Reference to this object

Definition at line 64 of file parameter_descriptor_builder.cpp.

floatingPointRange()

ParameterDescriptorBuilder & moveit_servo::ParameterDescriptorBuilder::floatingPointRange	(	double	from_value = std::numeric_limits<double>::min(),
		double	to_value = std::numeric_limits<double>::max(),
		double	step = 0
	)

Set floating point range.

Parameters

[in]	from_value	The from value
[in]	to_value	To value
[in]	step	The step

Returns

Reference to this object

Definition at line 71 of file parameter_descriptor_builder.cpp.

integerRange()

ParameterDescriptorBuilder & moveit_servo::ParameterDescriptorBuilder::integerRange	(	int64_t	from_value = std::numeric_limits<int64_t>::min(),
		int64_t	to_value = std::numeric_limits<int64_t>::max(),
		int64_t	step = 0
	)

Set the integer range.

Parameters

[in]	from_value	The from value
[in]	to_value	To value
[in]	step	The step

Returns

Reference to this object

Definition at line 83 of file parameter_descriptor_builder.cpp.

operator rcl_interfaces::msg::ParameterDescriptor()

moveit_servo::ParameterDescriptorBuilder::operator rcl_interfaces::msg::ParameterDescriptor ( ) const

inline

Rcl_interfaces::msg::parameterdescriptor conversion operator.

Definition at line 56 of file parameter_descriptor_builder.hpp.

readOnly()

ParameterDescriptorBuilder & moveit_servo::ParameterDescriptorBuilder::readOnly

(

bool

read_only

)

Sets the read only flag.

Parameters

[in]

read_only

The read only flag

Returns

Reference to this object

Definition at line 57 of file parameter_descriptor_builder.cpp.

type()

ParameterDescriptorBuilder & moveit_servo::ParameterDescriptorBuilder::type

(

uint8_t

type

)

Set the type.

Parameters

[in]

type

The type

Returns

Reference to this object

Definition at line 39 of file parameter_descriptor_builder.cpp.

---

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

• moveit_ros/moveit_servo/include/moveit_servo/parameter_descriptor_builder.hpp
• moveit_ros/moveit_servo/src/parameter_descriptor_builder.cpp