Class: Param

Param(options)

new Param(options)

A ROS parameter.

Parameters:
Name Type Description
options Object
Properties
Name Type Description
ros Ros

The ROSLIB.Ros connection handle.
name string

The param name, like max_vel_x.
Source:

Methods

delete(callbackopt, failedCallbackopt)

Delete this parameter on the ROS server.

Parameters:
Name Type Attributes Description
callback function <optional>

The callback function when the service call succeeded.
failedCallback function <optional>

The callback function when the service call failed.

Properties
Name Type Description
error string

The error message reported by ROS.
Source:

get(callback, failedCallbackopt)

Fetch the value of the param.

Parameters:
Name Type Attributes Description
callback function

Function with the following params:

Properties
Name Type Description
value Object

The value of the param from ROS.
failedCallback function <optional>

Function when the service call failed with the following params:

Properties
Name Type Description
error string

The error message reported by ROS.
Source:

set(value, callbackopt, failedCallbackopt)

Set the value of the param in ROS.

Parameters:
Name Type Attributes Description
value Object

The value to set param to.
callback function <optional>

The callback function.
failedCallback function <optional>

The callback function when the service call failed.

Properties
Name Type Description
error string

The error message reported by ROS.
Source: