JSDoc: Module: rclnodejs

A module that exposes the rclnodejs interfaces.

Source:

index.js, line 92

Members

member

(static) ActionClient

ActionClient class

Source:

index.js, line 154

member

(static) ActionServer

ActionServer class

Source:

index.js, line 157

member

(static) CancelResponse

ServerGoalHandle enum

Source:

index.js, line 166

member

(static) ClientGoalHandle

ClientGoalHandle class

Source:

index.js, line 160

member

(static) Clock

Clock class

Source:

index.js, line 97

member

(static) ClockType

ClockType enum

Source:

index.js, line 100

member

(static) Context

Context class

Source:

index.js, line 103

member

(static) Duration

Duration class

Source:

index.js, line 115

member

(static) FloatingPointRange

FloatingPointRange class

Source:

index.js, line 118

member

(static) GoalResponse

GoalResponse enum

Source:

index.js, line 169

member

(static) IntegerRange

IntegerRange class

Source:

index.js, line 121

member

(static) NodeOptions

NodeOptions class

Source:

index.js, line 127

member

(static) Parameter

Parameter

Source:

index.js, line 130

member

(static) ParameterDescriptor

ParameterDescriptor

Source:

index.js, line 133

member

(static) ParameterType

ParameterType

Source:

index.js, line 136

member

(static) QoS

QoS class

Source:

index.js, line 139

member

(static) ROSClock

ROSClock class

Source:

index.js, line 142

member

(static) ServerGoalHandle

ServerGoalHandle class

Source:

index.js, line 163

member

(static) Time

Time class

Source:

index.js, line 145

member

(static) TimeSource

TimeSource class

Source:

index.js, line 148

member

(static) getActionClientNamesAndTypesByNode

getActionClientNamesAndTypesByNode function

Source:

index.js, line 172

member

(static) getActionNamesAndTypes

getActionNamesAndTypes function

Source:

index.js, line 178

member

(static) getActionServerNamesAndTypesByNode

getActionServerNamesAndTypesByNode function

Source:

index.js, line 175

member

(static) logging

Logging class

Source:

index.js, line 124

member

(static) validator

validator object

Source:

index.js, line 151

member

(inner, constant) The :number

plus/minus tolerance for determining number equivalence.

Type:

number

Source:

index.js, line 105

See:

Methods

function

(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:

index.js, line 405

Returns:

A plain JavaScript of that type

Type Object | undefined

function

(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:

index.js, line 188

Returns:

The instance of Node.

Type Node

function

(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:

index.js, line 385

Returns:

Expanded topic name which is fully qualified.

Type string

function

(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:

index.js, line 220

Returns:

A Promise.

Type Promise.<undefined>

function

(static) isShutdown() → {boolean}

Return status that whether the module is shut down.

Source:

index.js, line 324

Returns:

Return true if the module is shut down, otherwise return false.

Type boolean

function

(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:

index.js, line 366

Returns:

- True if a given topic or service name is hidden, otherwise False.

Type boolean

function

(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:

index.js, line 343

Returns:

A Promise.

Type Promise.<undefined>

function

(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:

index.js, line 333

Returns:

- the object of the required package/interface.

Type object

function

(static) shutdown(context) → {undefined}

Parameters:

Name	Type	Description
`context`	Context	The context to be shutdown.

Source:

index.js, line 302

Returns:

Type undefined

function

(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:

index.js, line 272

Returns:

Type undefined

function

(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:

index.js, line 288

Returns:

Type undefined