API Reference

Class: LifecyclePublisher

ROS2.0 JavaScript client with Node.js

class

LifecyclePublisher()

A publisher that sends messages only when activated. This implementation is based on the rclcpp LifecyclePublisher class.
Source:

Methods

function

activate() → {unknown}

Enables communications; publish() will now send messages.
Source:
Returns:
Void return.
Type unknown
function

deactivate() → {unknown}

Disable communications; publish() will not send messages.
Source:
Returns:
Void return.
Type unknown
function

isActivated() → {boolean}

Determine if communications are enabled, i.e., activated, or disabled, i.e., deactivated.
Source:
Returns:
True if activated; otherwise false.
Type boolean
function

onActivate() → {unknown}

A lifecycle-node activation notice.
Source:
Returns:
Void return.
Type unknown
function

onDeactivate() → {unknown}

A lifecycle-node deactivation notice.
Source:
Returns:
Void return.
Type unknown
function

publish(message) → {undefined}

Publish a message only when activated; otherwise do nothing (nop);
Parameters:
Name Type Description
message object | Buffer The message to be sent, could be kind of JavaScript message generated from .msg or be a Buffer for a raw message.
Source:
Returns:
Type undefined