JSDoc: Class: ParameterDescriptor

Class: ParameterDescriptor

ParameterDescriptor(parameter) → {ParameterDescriptor}

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:

lib/parameter.js, line 271

Returns:

- The new instance.

Type: ParameterDescriptor

Members

additionalConstraints

Get additionalConstraints property.

Source:

lib/parameter.js, line 345

additionalConstraints

Set additionalConstraints property. .

Source:

lib/parameter.js, line 354

description

Get description.

Source:

lib/parameter.js, line 327

name

Get name.

Source:

lib/parameter.js, line 309

range

Get range.

Source:

lib/parameter.js, line 372

range

Set range. The range must be compatible with the type property.

Source:

lib/parameter.js, line 381

readOnly

Get readOnly property.

Source:

lib/parameter.js, line 336

type

Get type.

Source:

lib/parameter.js, line 318

Methods

hasRange() → {boolean}

Determine if rangeConstraint property has been set.

Source:

lib/parameter.js, line 363

Returns:

- The rangeConstraint property.

Type: boolean

toMessage() → {rcl_interfaces.msg.ParameterDescriptor}

Create a rcl_interfaces.msg.ParameterDescriptor from this descriptor.

Source:

lib/parameter.js, line 466

Returns:

- The new message.

Type: rcl_interfaces.msg.ParameterDescriptor

validate() → {undefined}

Check the state and ensure it is valid. Throw a TypeError if invalid state is detected.

Source:

lib/parameter.js, line 402

Returns:

Type: undefined

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:

lib/parameter.js, line 435

Returns:

Type: undefined

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

A node parameter descriptor.

Constructor

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.