Global

Members

(constant) CallbackReturnCode :number

The values returned by TransitionCallback.
Type:
  • number
Source:

(constant) CancelResponse :number

Possible cancel responses.
Type:
  • number
Properties:
Name Type Description
REJECT number
ACCEPT number
Source:

(constant) ClockType :number

Enum for ClockType
Type:
  • number
Properties:
Name Type Description
ROS_TIME number
SYSTEM_TIME number
STEADY_TIME number
Source:

(constant) DEFAULT_NUMERIC_RANGE_TOLERANCE :number

The plus/minus tolerance for determining number equivalence.
Type:
  • number
Source:
See:

(constant) DistroId

enum style distribution identifiers
Source:

(readonly) DurabilityPolicy :number

Enum for DurabilityPolicy
Type:
  • number
Properties:
Name Type Description
RMW_QOS_POLICY_DURABILITY_SYSTEM_DEFAULT number
RMW_QOS_POLICY_DURABILITY_TRANSIENT_LOCAL number
RMW_QOS_POLICY_DURABILITY_VOLATILE number
Source:

(constant) GoalResponse :number

Possible goal responses.
Type:
  • number
Properties:
Name Type Description
REJECT number
ACCEPT number
Source:

(readonly) HistoryPolicy :number

Enum for HistoryPolicy
Type:
  • number
Properties:
Name Type Description
RMW_QOS_POLICY_HISTORY_SYSTEM_DEFAULT number
RMW_QOS_POLICY_HISTORY_KEEP_LAST number
RMW_QOS_POLICY_HISTORY_KEEP_ALL number
Source:

(readonly) LoggingSeverity :number

Enum for LoggingSeverity
Type:
  • number
Properties:
Name Type Description
UNSET number
DEBUG number
INFO number
WARN number
ERROR number
FATAL number
Source:

(constant) ParameterType :number

Enum for ParameterType
Type:
  • number
Properties:
Name Type Description
PARAMETER_NOT_SET number
PARAMETER_BOOL number
PARAMETER_INTEGER number
PARAMETER_DOUBLE number
PARAMETER_STRING number
PARAMETER_BYTE_ARRAY number
PARAMETER_BOOL_ARRAY number
PARAMETER_INTEGER_ARRAY number
PARAMETER_DOUBLE_ARRAY number
PARAMETER_STRING_ARRAY number
Source:

(readonly) ReliabilityPolicy :number

Enum for ReliabilityPolicy
Type:
  • number
Properties:
Name Type Description
RMW_QOS_POLICY_RELIABILITY_SYSTEM_DEFAULT number
RMW_QOS_POLICY_RELIABILITY_RELIABLE number
RMW_QOS_POLICY_RELIABILITY_BEST_EFFORT number
Source:

(constant) ServiceIntrospectionStates :ServiceIntrospectionState

Enum for service introspection states.
Type:
Properties:
Name Type Description
OFF ServiceIntrospectionState
METADATA ServiceIntrospectionState
CONTENTS ServiceIntrospectionState
Source:

Methods

defaultCancelCallback() → {number}

No cancellations.
Source:
Returns:
- Always responds with rejection
Type
number

defaultGoalCallback() → {number}

Accept all goals.
Source:
Returns:
- Always responds with acceptance.
Type
number

defaultHandleAcceptedCallback(goalHandle) → {undefined}

Execute the goal.
Parameters:
Name Type Description
goalHandle ServerGoalHandle The server goal handle.
Source:
Returns:
Type
undefined

getActionClientNamesAndTypesByNode(node, nodeName, namespace) → {array}

Get a list of action names and types for action clients associated with a node.
Parameters:
Name Type Description
node Node The node used for discovery.
nodeName string The name of a remote node to get action clients for.
namespace string Namespace of the remote node.
Source:
Returns:
- An array of the names and types.
Type
array

getActionNamesAndTypes(node) → {array}

Get a list of action names and types.
Parameters:
Name Type Description
node Node The node used for discovery.
Source:
Returns:
- An array of the names and types.
Type
array

getActionServerNamesAndTypesByNode(node, nodeName, namespace) → {array}

Get a list of action names and types for action servers associated with a node.
Parameters:
Name Type Description
node Node The node used for discovery.
nodeName string The name of a remote node to get action servers for.
namespace string Namespace of the remote node.
Source:
Returns:
- An array of the names and types.
Type
array

(async) getCurrentGeneratorVersion() → {Promise.<(string|null)>}

Get the version of the generator that was used for the currently present interfaces.
Source:
Throws:
if there was an error reading the *generator.json* file (except for it being absent)
Type
Error
Returns:
The current version or null if the *generator.json* file was not found
Type
Promise.<(string|null)>

parameterTypeFromValue(value) → {ParameterType}

Infer a ParameterType for JS primitive types: string, boolean, number and arrays of these types. A TypeError is thrown for a value who's type is not one of the set listed.
Parameters:
Name Type Description
value any The value to infer it's ParameterType
Source:
Returns:
- The ParameterType that best scribes the value.
Type
ParameterType

validType(parameterType) → {boolean}

Determine if a number maps to is a valid ParameterType.
Parameters:
Name Type Description
parameterType ParameterType The value to test.
Source:
Returns:
- True if value is a valid ParameterType; false otherwise.
Type
boolean

validValue(value, type) → {boolean}

Test if value can be represented by a ParameterType.
Parameters:
Name Type Description
value number The value to test.
type ParameterType The ParameterType to test value against.
Source:
Returns:
- True if value can be represented by type.
Type
boolean

Type Definitions

RequestCallback(request, response) → {undefined}

This callback is called when a request is sent to service
Parameters:
Name Type Description
request Object The request sent to the service
response Response The response to client. Use response.send() to send response object to client
Source:
See:
Returns:
Type
undefined

ResponseCallback(response)

This callback is called when a resopnse is sent back from service
Parameters:
Name Type Description
response Object The response sent from the service
Source:
See:

SerializedState

Type:
  • object
Properties:
Name Type Description
id number code identifying the type of this state.
label string readable name of this state.
Source:

ServiceIntrospectionState

Type:
  • number
Source:

SetParametersCallback(parameters) → {rcl_interfaces.msg.SetParameterResult}

This callback is called when declaring a parameter or setting a parameter. The callback is provided a list of parameters and returns a SetParameterResult to indicate approval or veto of the operation.
Parameters:
Name Type Description
parameters Array.<Parameter> The message published
Source:
See:
Returns:
-
Type
rcl_interfaces.msg.SetParameterResult

SubscriptionCallback(message)

This callback is called when a message is published
Parameters:
Name Type Description
message Object The message published
Source:
See:

TransitionCallback(previousState) → {CallbackReturnCode}

This callback is invoked when LifecycleNode is transitioning to a new state.
Parameters:
Name Type Description
previousState State The previous node lifecycle state.
Source:
See:
Returns:
- The result of the callback.
Type
CallbackReturnCode