Constructor
new ParameterService(node)
Create a new instance.
Parameters:
| Name | Type | Description |
|---|---|---|
node |
Node | The node these services will support. |
- Source:
Members
node
Get the node this
- Source:
Methods
_handleDescribeParameters(request, response) → {undefined}
Get a list of ParameterDescriptors.
Request.names identifies the descriptors to get.
If request.names is empty, get all descriptors.
The body of the response is a rcl_interfaces.msg.DescribeParametersResult.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
DescribeParameters_Request | The client request |
response |
DescribeParameters_Response | The server response with an array of ParameterDescriptors. |
- Source:
Returns:
-
- Type
- undefined
_handleGetParameters(request, response) → {undefined}
Get a list of ParameterValue.
request.names identifies the parameter values to get.
If request.names is empty return the value of all parameters.
The body of the response is a rcl_interfaces.msg.ParameterValue[].
Parameters:
| Name | Type | Description |
|---|---|---|
request |
GetParameters_Request | The client request. |
response |
GetParameters_Response | The service response with an array of ParameterValue. |
- Source:
Returns:
-
- Type
- undefined
_handleListParameters(request, response) → {undefined}
Get a list of parameter names.
The body of the response is a rcl_interfaces.msg.ListParametersResult.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
ListParameters_Request | The client request. |
response |
ListParameters_Response | The service response with a list of parameter names. |
- Source:
Returns:
-
- Type
- undefined
_handleSetParameters(request, response) → {undefined}
Update a list of parameters.
Process each setParameter operation in the order defined by the request.
The result is an rcl_interfaces.msg.SetParametersResult[], one result
for each parameter.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
SetParameters_Request | The client request. |
response |
SetParameters_Response | The service response with a SetParametersResult[] |
- Source:
Returns:
-
- Type
- undefined
_handleSetParametersAtomically(request, response) → {undefined}
Update a list of parameters atomically.
The body of the response is a rcl_interfaces.msg.SetParametersResult
Parameters:
| Name | Type | Description |
|---|---|---|
request |
SetParameters_Request | The client request. |
response |
SetParameters_Response | The service response with a single SetParametersResult for the entire process. |
- Source:
Returns:
-
- Type
- undefined
isStarted() → {boolean}
Check if interface services are configured and accepting requests.
- Source:
Returns:
- True if services are active; false otherwise.
- Type
- boolean
start() → {undefined}
Configure parameter services and begin processing client requests.
If this service is already started the request is ignored, i.e., a nop.
- Source:
Returns:
- Type
- undefined