API Reference

Class: ParameterDescriptor

ROS2.0 JavaScript client with Node.js

class

ParameterDescriptor(parameter) → {ParameterDescriptor}

class

new ParameterDescriptor(parameter) → {ParameterDescriptor}

Create a new instance from a parameter.
Parameters:
Name Type Description
parameter Parameter The parameter from which new instance is constructed.
Source:
Returns:
- The new instance.
Type ParameterDescriptor

Members

member

additionalConstraints

Get additionalConstraints property.
Source:
member

additionalConstraints

Set additionalConstraints property. .
Source:
member

description

Get description.
Source:
member

name

Get name.
Source:
member

range

Get range.
Source:
member

range

Set range. The range must be compatible with the type property.
Source:
member

readOnly

Get readOnly property.
Source:
member

type

Get type.
Source:

Methods

function

hasRange() → {boolean}

Determine if rangeConstraint property has been set.
Source:
Returns:
- The rangeConstraint property.
Type boolean
function

toMessage() → {rcl_interfaces.msg.ParameterDescriptor}

Create a rcl_interfaces.msg.ParameterDescriptor from this descriptor.
Source:
Returns:
- The new message.
Type rcl_interfaces.msg.ParameterDescriptor
function

validate() → {undefined}

Check the state and ensure it is valid. Throw a TypeError if invalid state is detected.
Source:
Returns:
Type undefined
function

validateParameter(parameter) → {undefined}

Check a parameter for consistency with this descriptor. Throw an Error if an inconsistent state is detected.
Parameters:
Name Type Description
parameter Parameter The parameter to test for consistency.
Source:
Returns:
Type undefined
class

ParameterDescriptor(name, type, descriptionopt, readOnlyopt, rangeopt)

A node parameter descriptor.

Constructor

class

new ParameterDescriptor(name, type, descriptionopt, readOnlyopt, rangeopt)

Create new instances.
Parameters:
Name Type Attributes Default Description
name string The descriptor name, must be a valid name.
type ParameterType The type identifier.
description string <optional>
 no description A descriptive string.
readOnly boolean <optional>
 false True indicates a parameter of this type can not be modified. Default = false.
range Range <optional>
 null An optional IntegerRange or FloatingPointRange.
Source:

Members

member

additionalConstraints

Get additionalConstraints property.
Source:
member

additionalConstraints

Set additionalConstraints property. .
Source:
member

description

Get description.
Source:
member

name

Get name.
Source:
member

range

Get range.
Source:
member

range

Set range. The range must be compatible with the type property.
Source:
member

readOnly

Get readOnly property.
Source:
member

type

Get type.
Source:

Methods

function

hasRange() → {boolean}

Determine if rangeConstraint property has been set.
Source:
Returns:
- The rangeConstraint property.
Type boolean
function

toMessage() → {rcl_interfaces.msg.ParameterDescriptor}

Create a rcl_interfaces.msg.ParameterDescriptor from this descriptor.
Source:
Returns:
- The new message.
Type rcl_interfaces.msg.ParameterDescriptor
function

validate() → {undefined}

Check the state and ensure it is valid. Throw a TypeError if invalid state is detected.
Source:
Returns:
Type undefined
function

validateParameter(parameter) → {undefined}

Check a parameter for consistency with this descriptor. Throw an Error if an inconsistent state is detected.
Parameters:
Name Type Description
parameter Parameter The parameter to test for consistency.
Source:
Returns:
Type undefined