API Reference

Class: Parameter

ROS2.0 JavaScript client with Node.js

class

Parameter(parameterMsg) → {Parameter}

class

new Parameter(parameterMsg) → {Parameter}

Create a Parameter instance from an rlc_interfaces/msg/Parameter message.
Parameters:
Name Type Description
parameterMsg rcl_interfaces/msg/Parameter The message to convert to a parameter.
Source:
Returns:
- The new instance.
Type Parameter

Members

member

name

Get name
Source:
member

type

Get type
Source:
member

value

Get value.
Source:
member

value

Set value. Value must be compatible with the type property.
Source:

Methods

function

toParameterMessage() → {rcl_interfaces.msg.Parameter}

Create a rcl_interfaces.msg.Parameter from this instance.
Source:
Returns:
- The new instance.
Type rcl_interfaces.msg.Parameter
function

toParameterValueMessage() → {rcl_interfaces.msg.ParameterValue}

Create a rcl_interfaces.msg.ParameterValue from this instance.
Source:
Returns:
- The new instance.
Type rcl_interfaces.msg.ParameterValue
function

validate() → {undefined}

Check the state of this property. Throw TypeError on first property with invalid type.
Source:
Returns:
Type undefined
class

Parameter(name, type, value)

A node parameter.

Constructor

class

new Parameter(name, type, value)

Create new parameter instances.
Parameters:
Name Type Description
name string The parameter name, must be a valid name.
type ParameterType The type identifier.
value any The parameter value.
Source:

Members

member

name

Get name
Source:
member

type

Get type
Source:
member

value

Get value.
Source:
member

value

Set value. Value must be compatible with the type property.
Source:

Methods

function

toParameterMessage() → {rcl_interfaces.msg.Parameter}

Create a rcl_interfaces.msg.Parameter from this instance.
Source:
Returns:
- The new instance.
Type rcl_interfaces.msg.Parameter
function

toParameterValueMessage() → {rcl_interfaces.msg.ParameterValue}

Create a rcl_interfaces.msg.ParameterValue from this instance.
Source:
Returns:
- The new instance.
Type rcl_interfaces.msg.ParameterValue
function

validate() → {undefined}

Check the state of this property. Throw TypeError on first property with invalid type.
Source:
Returns:
Type undefined