rosros.rclify.parameter.SetParametersResult Class Reference

This is the message to communicate the result of setting parameters. More...

Public Member Functions
	__init__ (self, successful=False, reason="")

Public Attributes
	reason
	Reason why the setting was either successful or a failure.
	successful
	A true value of the same index indicates that the parameter was set successfully.

Detailed Description

This is the message to communicate the result of setting parameters.

Stand-in for ROS2 `rcl_interfaces.msg.SetParametersResult` in ROS1.

Definition at line 249 of file parameter.py.

Constructor & Destructor Documentation

__init__()

rosros.rclify.parameter.SetParametersResult.__init__	(		self,
			successful = False,
			reason = ""
	)

Definition at line 251 of file parameter.py.

Member Data Documentation

reason

rosros.rclify.parameter.SetParametersResult.reason

Reason why the setting was either successful or a failure.

This should only be used for logging and user interfaces.

Definition at line 257 of file parameter.py.

successful

rosros.rclify.parameter.SetParametersResult.successful

A true value of the same index indicates that the parameter was set successfully.

A false value indicates the change was rejected.

Definition at line 254 of file parameter.py.

---

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

• rosros/rclify/parameter.py