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
additionalConstraints
Get additionalConstraints property.
- Source:
additionalConstraints
Set additionalConstraints property. .
- Source:
description
Get description.
- Source:
name
Get name.
- Source:
range
Get range.
- Source:
range
Set range.
The range must be compatible with the type property.
- Source:
readOnly
Get readOnly property.
- Source:
type
Get type.
- Source:
Methods
hasRange() → {boolean}
Determine if rangeConstraint property has been set.
- Source:
Returns:
- The rangeConstraint property.
- Type
- boolean
toMessage() → {rcl_interfaces.msg.ParameterDescriptor}
Create a rcl_interfaces.msg.ParameterDescriptor from this descriptor.
- Source:
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:
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:
Returns:
- Type
- undefined