Module: rclnodejs

A module that exposes the rclnodejs interfaces.
Source:

Members

(static) Clock

Clock class
Source:

(static) ClockType

ClockType enum
Source:

(static) Context

Context class
Source:

(static) Duration

Duration class
Source:

(static) logging

Logging class
Source:

(static) NodeOptions

NodeOptions class
Source:

(static) Parameters

Parameters
Source:

(static) QoS

QoS class
Source:

(static) ROSClock

ROSClock class
Source:

(static) Time

Time class
Source:

(static) TimeSource

TimeSource class
Source:

(static) validator

validator object
Source:

Methods

(static) createMessageObject(type) → {Object|undefined}

Create a plain JavaScript by specified type identifier
Parameters:
Name Type Description
type string | Object - the type identifier, acceptable formats could be 'std_msgs/std/String' or {package: 'std_msgs', type: 'msg', name: 'String'}
Source:
Returns:
A plain JavaScript of that type
Type
Object | undefined

(static) createNode(nodeName, namespace, context, options) → {Node}

Create a node.
Parameters:
Name Type Description
nodeName string The name used to register in ROS.
namespace string The namespace used in ROS, default is an empty string.
context Context The context, default is Context.defaultContext().
options NodeOptions The options to configure the new node behavior.
Source:
Returns:
The instance of Node.
Type
Node

(static) expandTopicName(topicName, nodeName, nodeNamespace) → {string}

Expand a given topic name using given node name and namespace as well.
Parameters:
Name Type Description
topicName string Topic name to be expanded.
nodeName string Name of the node that this topic is associated with.
nodeNamespace string Namespace that the topic is within.
Source:
Returns:
Expanded topic name which is fully qualified.
Type
string

(static) init(context, argv) → {Promise.<undefined>}

Init the module.
Parameters:
Name Type Description
context Context The context, default is Context.defaultContext().
argv Array.<string> Process commandline arguments.
Source:
Returns:
A Promise.
Type
Promise.<undefined>

(static) isShutdown() → {boolean}

Return status that whether the module is shut down.
Source:
Returns:
Return true if the module is shut down, otherwise return false.
Type
boolean

(static) isTopicOrServiceHidden(name) → {boolean}

Judge if the topic/service is hidden, see http://design.ros2.org/articles/topic_and_service_names.html#hidden-topic-or-service-names
Parameters:
Name Type Description
name string Name of topic/service.
Source:
Returns:
- True if a given topic or service name is hidden, otherwise False.
Type
boolean

(static) regenerateAll() → {Promise.<undefined>}

Search packgaes which locate under path $AMENT_PREFIX_PATH, regenerate all JavaScript structs files from the IDL of messages(.msg) and services(.srv) and put these files under folder 'generated'. Any existing files under this folder will be overwritten after the execution.
Source:
Returns:
A Promise.
Type
Promise.<undefined>

(static) require(name) → {object}

Get the interface package, which is used by publisher/subscription or client/service.
Parameters:
Name Type Description
name string The name of interface to be required.
Source:
Returns:
- the object of the required package/interface.
Type
object

(static) shutdown(context) → {undefined}

Parameters:
Name Type Description
context Context The context to be shutdown.
Source:
Returns:
Type
undefined

(static) spin(node, timeoutopt) → {undefined}

Start to spin the node, which triggers the event loop to start to check the incoming events.
Parameters:
Name Type Attributes Default Description
node Node The node to be spun.
timeout number <optional>
 10 ms to wait, block forever if negative, don't wait if 0, default is 10.
Source:
Returns:
Type
undefined

(static) spinOnce(node, timeoutopt) → {undefined}

Execute one item of work or wait until a timeout expires.
Parameters:
Name Type Attributes Default Description
node Node The node to be spun.
timeout number <optional>
 10 ms to wait, block forever if negative, don't wait if 0, default is 10.
Source:
Returns:
Type
undefined