org.ros.node.Node Interface Reference

Inheritance diagram for org.ros.node.Node:

List of all members.

Public Member Functions
void	addListener (NodeListener listener)
void	executeCancellableLoop (CancellableLoop cancellableLoop)
Log	getLog ()
URI	getMasterUri ()
MessageSerializationFactory	getMessageSerializationFactory ()
GraphName	getName ()
NodeNameResolver	getResolver ()
ScheduledExecutorService	getScheduledExecutorService ()
MessageFactory	getServiceRequestMessageFactory ()
MessageFactory	getServiceResponseMessageFactory ()
MessageFactory	getTopicMessageFactory ()
URI	getUri ()
GraphName	resolveName (GraphName name)
GraphName	resolveName (String name)
void	shutdown ()

---

Detailed Description

A node in the ROS graph.

Author:

khughes@google.com (Keith M. Hughes)

Definition at line 35 of file Node.java.

---

Member Function Documentation

void org.ros.node.Node.addListener

(

NodeListener

listener

)

Add a new NodeListener to the Node.

Parameters:

listener

the NodeListener to add

Implemented in org.ros.internal.node.DefaultNode.

void org.ros.node.Node.executeCancellableLoop

(

CancellableLoop

cancellableLoop

)

Executes a CancellableLoop using the Node's ScheduledExecutorService. The CancellableLoop will be canceled when the Node starts shutting down.

Any blocking calls executed in the provided CancellableLoop can potentially delay Node shutdown and should be avoided.

Parameters:

cancellableLoop

the CancellableLoop to execute

Log org.ros.node.Node.getLog

(

)

Returns:

Logger for this node, which will also perform logging to /rosout.

Implemented in org.ros.internal.node.DefaultNode.

URI org.ros.node.Node.getMasterUri

(

)

Returns:

URI of MasterXmlRpcEndpoint that this node is attached to.

Implemented in org.ros.internal.node.DefaultNode.

MessageSerializationFactory org.ros.node.Node.getMessageSerializationFactory

(

)

Returns:

the MessageSerializationFactory used by this node

Implemented in org.ros.internal.node.DefaultNode.

GraphName org.ros.node.Node.getName

(

)

Returns:

the fully resolved name of this Node, e.g. "/foo/bar/boop"

Implemented in org.ros.internal.node.DefaultNode.

NodeNameResolver org.ros.node.Node.getResolver

(

)

Returns:

NodeNameResolver for this namespace

Implemented in org.ros.internal.node.DefaultNode.

ScheduledExecutorService org.ros.node.Node.getScheduledExecutorService

(

)

Returns:

the ScheduledExecutorService that this Node uses

Implemented in org.ros.internal.node.DefaultNode.

MessageFactory org.ros.node.Node.getServiceRequestMessageFactory

(

)

Returns:

the MessageFactory used by this node for service requests

Implemented in org.ros.internal.node.DefaultNode.

MessageFactory org.ros.node.Node.getServiceResponseMessageFactory

(

)

Returns:

the MessageFactory used by this node for service responses

Implemented in org.ros.internal.node.DefaultNode.

MessageFactory org.ros.node.Node.getTopicMessageFactory

(

)

Returns:

the MessageFactory used by this node

Implemented in org.ros.internal.node.DefaultNode.

URI org.ros.node.Node.getUri

(

)

Returns:

the URI of this Node

Implemented in org.ros.internal.node.DefaultNode.

GraphName org.ros.node.Node.resolveName

(

GraphName

name

)

Resolve the given name, using ROS conventions, into a full ROS namespace name. Will be relative to the current namespace unless the name is global.

Parameters:

name	the name to resolve

Returns:

fully resolved ros namespace name

Implemented in org.ros.internal.node.DefaultNode.

GraphName org.ros.node.Node.resolveName

(

String

name

)

See also:

resolveName(GraphName)

Implemented in org.ros.internal.node.DefaultNode.

void org.ros.node.Node.shutdown

(

)

Shut the node down.

Implemented in org.ros.internal.node.DefaultNode.

---

The documentation for this interface was generated from the following file:

• Node.java