Public Member Functions
URI	getMasterUri ()
MessageSerializationFactory	getMessageSerializationFactory ()
GraphName	getNodeName ()
NameResolver	getParentResolver ()
List< File >	getRosPackagePath ()
File	getRosRoot ()
ServiceDescriptionFactory	getServiceDescriptionFactory ()
MessageFactory	getServiceRequestMessageFactory ()
MessageFactory	getServiceResponseMessageFactory ()
AdvertiseAddress	getTcpRosAdvertiseAddress ()
AdvertiseAddressFactory	getTcpRosAdvertiseAddressFactory ()
BindAddress	getTcpRosBindAddress ()
TimeProvider	getTimeProvider ()
TopicDescriptionFactory	getTopicDescriptionFactory ()
MessageFactory	getTopicMessageFactory ()
AdvertiseAddress	getXmlRpcAdvertiseAddress ()
AdvertiseAddressFactory	getXmlRpcAdvertiseAddressFactory ()
BindAddress	getXmlRpcBindAddress ()
NodeConfiguration	setDefaultNodeName (GraphName nodeName)
NodeConfiguration	setDefaultNodeName (String nodeName)
NodeConfiguration	setMasterUri (URI masterUri)
NodeConfiguration	setMessageSerializationFactory (MessageSerializationFactory messageSerializationFactory)
NodeConfiguration	setNodeName (GraphName nodeName)
NodeConfiguration	setNodeName (String nodeName)
NodeConfiguration	setParentResolver (NameResolver resolver)
NodeConfiguration	setRosPackagePath (List< File > rosPackagePath)
NodeConfiguration	setRosRoot (File rosRoot)
NodeConfiguration	setServiceDescriptionFactory (ServiceDescriptionFactory serviceDescriptionFactory)
NodeConfiguration	setServiceRequestMessageFactory (ServiceRequestMessageFactory serviceRequestMessageFactory)
NodeConfiguration	setServiceResponseMessageFactory (ServiceResponseMessageFactory serviceResponseMessageFactory)
NodeConfiguration	setTcpRosAdvertiseAddressFactory (AdvertiseAddressFactory tcpRosAdvertiseAddressFactory)
NodeConfiguration	setTcpRosBindAddress (BindAddress tcpRosBindAddress)
NodeConfiguration	setTimeProvider (TimeProvider timeProvider)
NodeConfiguration	setTopicDescriptionFactory (TopicDescriptionFactory topicDescriptionFactory)
NodeConfiguration	setTopicMessageFactory (MessageFactory topicMessageFactory)
NodeConfiguration	setXmlRpcAdvertiseAddressFactory (AdvertiseAddressFactory xmlRpcAdvertiseAddressFactory)
NodeConfiguration	setXmlRpcBindAddress (BindAddress xmlRpcBindAddress)
Static Public Member Functions
static NodeConfiguration	copyOf (NodeConfiguration nodeConfiguration)
static NodeConfiguration	newPrivate (URI masterUri)
static NodeConfiguration	newPrivate ()
static NodeConfiguration	newPublic (String host, URI masterUri)
static NodeConfiguration	newPublic (String host)
Static Public Attributes
static final URI	DEFAULT_MASTER_URI
Static Package Functions
	[static initializer]
Private Member Functions
	NodeConfiguration ()
Private Attributes
URI	masterUri
MessageSerializationFactory	messageSerializationFactory
GraphName	nodeName
NameResolver	parentResolver
List< File >	rosPackagePath
File	rosRoot
ScheduledExecutorService	scheduledExecutorService
ServiceDescriptionFactory	serviceDescriptionFactory
MessageFactory	serviceRequestMessageFactory
MessageFactory	serviceResponseMessageFactory
AdvertiseAddressFactory	tcpRosAdvertiseAddressFactory
BindAddress	tcpRosBindAddress
TimeProvider	timeProvider
TopicDescriptionFactory	topicDescriptionFactory
MessageFactory	topicMessageFactory
AdvertiseAddressFactory	xmlRpcAdvertiseAddressFactory
BindAddress	xmlRpcBindAddress

Detailed Description

Stores configuration information (e.g. ROS master URI) for Nodes.

See also:: Node documentation

Author:: ethan.rublee@gmail.com (Ethan Rublee); kwc@willowgarage.com (Ken Conley); damonkohler@google.com (Damon Kohler)

Definition at line 57 of file NodeConfiguration.java.

Constructor & Destructor Documentation

org.ros.node.NodeConfiguration.NodeConfiguration ( ) [inline, private]

Definition at line 181 of file NodeConfiguration.java.

Member Function Documentation

org.ros.node.NodeConfiguration.[static initializer] ( ) [inline, static, package]

static NodeConfiguration org.ros.node.NodeConfiguration.copyOf ( NodeConfiguration nodeConfiguration ) [inline, static]

Parameters:

nodeConfiguration the NodeConfiguration to copy

Returns:: a copy of the supplied NodeConfiguration

Definition at line 95 of file NodeConfiguration.java.

URI org.ros.node.NodeConfiguration.getMasterUri ( ) [inline]

See also:: ROS_MASTER_URI documentation

Returns:: the URI of the master that the Node will register with

Definition at line 217 of file NodeConfiguration.java.

MessageSerializationFactory org.ros.node.NodeConfiguration.getMessageSerializationFactory ( ) [inline]

Returns:: the MessageSerializationFactory for the Node

Definition at line 345 of file NodeConfiguration.java.

GraphName org.ros.node.NodeConfiguration.getNodeName ( ) [inline]

Returns:: the name of the Node

Definition at line 294 of file NodeConfiguration.java.

NameResolver org.ros.node.NodeConfiguration.getParentResolver ( ) [inline]

Returns:: the NameResolver for the Node's parent namespace

Definition at line 196 of file NodeConfiguration.java.

List<File> org.ros.node.NodeConfiguration.getRosPackagePath ( ) [inline]

These ordered paths tell the ROS system where to search for more ROS packages. If there are multiple packages of the same name, ROS will choose the one that appears in the List first.

See also:: ROS_PACKAGE_PATH documentation

Returns:: the List of paths where the system will look for ROS packages

Definition at line 269 of file NodeConfiguration.java.

File org.ros.node.NodeConfiguration.getRosRoot ( ) [inline]

See also:: ROS_ROOT documentation

Returns:: the location where the ROS core packages are installed

Definition at line 241 of file NodeConfiguration.java.

ServiceDescriptionFactory org.ros.node.NodeConfiguration.getServiceDescriptionFactory ( ) [inline]

Definition at line 430 of file NodeConfiguration.java.

MessageFactory org.ros.node.NodeConfiguration.getServiceRequestMessageFactory ( ) [inline]

Definition at line 385 of file NodeConfiguration.java.

MessageFactory org.ros.node.NodeConfiguration.getServiceResponseMessageFactory ( ) [inline]

Definition at line 400 of file NodeConfiguration.java.

AdvertiseAddress org.ros.node.NodeConfiguration.getTcpRosAdvertiseAddress ( ) [inline]

See also:: TCPROS documentation

Returns:: the AdvertiseAddress for the Node's TCPROS server

Definition at line 483 of file NodeConfiguration.java.

AdvertiseAddressFactory org.ros.node.NodeConfiguration.getTcpRosAdvertiseAddressFactory ( ) [inline]

See also:: TCPROS documentation

Returns:: the AdvertiseAddressFactory for the Node's TCPROS server

Definition at line 460 of file NodeConfiguration.java.

BindAddress org.ros.node.NodeConfiguration.getTcpRosBindAddress ( ) [inline]

See also:: TCPROS documentation

Returns:: the BindAddress for the Node's TCPROS server

Definition at line 439 of file NodeConfiguration.java.

TimeProvider org.ros.node.NodeConfiguration.getTimeProvider ( ) [inline]

Returns:: the configured TimeProvider

Definition at line 547 of file NodeConfiguration.java.

TopicDescriptionFactory org.ros.node.NodeConfiguration.getTopicDescriptionFactory ( ) [inline]

Definition at line 415 of file NodeConfiguration.java.

MessageFactory org.ros.node.NodeConfiguration.getTopicMessageFactory ( ) [inline]

Definition at line 370 of file NodeConfiguration.java.

AdvertiseAddress org.ros.node.NodeConfiguration.getXmlRpcAdvertiseAddress ( ) [inline]

See also:: Node documentation

Returns:: the AdvertiseAddress for the Node's XML-RPC server

Definition at line 515 of file NodeConfiguration.java.

AdvertiseAddressFactory org.ros.node.NodeConfiguration.getXmlRpcAdvertiseAddressFactory ( ) [inline]

See also:: Node documentation

Returns:: the AdvertiseAddressFactory for the Node's XML-RPC server

Definition at line 526 of file NodeConfiguration.java.

BindAddress org.ros.node.NodeConfiguration.getXmlRpcBindAddress ( ) [inline]

See also:: Node documentation

Returns:: the BindAddress for the Node's XML-RPC server

Definition at line 493 of file NodeConfiguration.java.

static NodeConfiguration org.ros.node.NodeConfiguration.newPrivate ( URI masterUri ) [inline, static]

Creates a new NodeConfiguration for a Node that is only accessible on the local host.

Parameters:

masterUri the URI for the master that the Node will register with

Returns:: a new NodeConfiguration for a private Node

Definition at line 161 of file NodeConfiguration.java.

static NodeConfiguration org.ros.node.NodeConfiguration.newPrivate ( ) [inline, static]

Creates a new NodeConfiguration for a Node that is only accessible on the local host.

Returns:: a new NodeConfiguration for a private Node

Definition at line 177 of file NodeConfiguration.java.

static NodeConfiguration org.ros.node.NodeConfiguration.newPublic	(	String	host,
		URI	masterUri
	)		`[inline, static]`

Creates a new NodeConfiguration for a publicly accessible Node.

Parameters:

host	the host that the Node will run on
masterUri	the URI for the master that the Node will register with

Returns:: a new NodeConfiguration for a publicly accessible Node

Definition at line 129 of file NodeConfiguration.java.

static NodeConfiguration org.ros.node.NodeConfiguration.newPublic ( String host ) [inline, static]

Creates a new NodeConfiguration for a publicly accessible Node.

Parameters:

host	the host that the Node will run on

Returns:: a new NodeConfiguration for a publicly accessible Node

Definition at line 148 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setDefaultNodeName ( GraphName nodeName ) [inline]

Sets the name of the Node if the name has not already been set.

Parameters:

nodeName the name of the Node

Returns:: this NodeConfiguration

Definition at line 324 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setDefaultNodeName ( String nodeName ) [inline]

Sets the name of the Node if the name has not already been set.

Parameters:

nodeName the name of the Node

Returns:: this NodeConfiguration

Definition at line 338 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setMasterUri ( URI masterUri ) [inline]

See also:: ROS_MASTER_URI documentation

Parameters:

masterUri the URI of the master that the Node will register with

Returns:: this NodeConfiguration

Definition at line 230 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setMessageSerializationFactory ( MessageSerializationFactory messageSerializationFactory ) [inline]

Parameters:

messageSerializationFactory the MessageSerializationFactory for the Node

Returns:: this NodeConfiguration

Definition at line 354 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setNodeName ( GraphName nodeName ) [inline]

Parameters:

nodeName the name of the Node

Returns:: this NodeConfiguration

Definition at line 303 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setNodeName ( String nodeName ) [inline]

Parameters:

nodeName the name of the Node

Returns:: this NodeConfiguration

Definition at line 313 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setParentResolver ( NameResolver resolver ) [inline]

Parameters:

resolver the NameResolver for the Node's parent namespace

Returns:: this NodeConfiguration

Definition at line 205 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setRosPackagePath ( List< File > rosPackagePath ) [inline]

These ordered paths tell the ROS system where to search for more ROS packages. If there are multiple packages of the same name, ROS will choose the one that appears in the List first.

See also:: ROS_PACKAGE_PATH documentation

Parameters:

rosPackagePath the List of paths where the system will look for ROS packages

Returns:: this NodeConfiguration

Definition at line 286 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setRosRoot ( File rosRoot ) [inline]

See also:: ROS_ROOT documentation

Parameters:

rosRoot the location where the ROS core packages are installed

Returns:: this NodeConfiguration

Definition at line 253 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setServiceDescriptionFactory ( ServiceDescriptionFactory serviceDescriptionFactory ) [inline]

Parameters:

serviceDescriptionFactory the ServiceDescriptionFactory for the Node

Returns:: this NodeConfiguration

Definition at line 424 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setServiceRequestMessageFactory ( ServiceRequestMessageFactory serviceRequestMessageFactory ) [inline]

Parameters:

serviceRequestMessageFactory the ServiceRequestMessageFactory for the Node

Returns:: this NodeConfiguration

Definition at line 379 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setServiceResponseMessageFactory ( ServiceResponseMessageFactory serviceResponseMessageFactory ) [inline]

Parameters:

serviceResponseMessageFactory the ServiceResponseMessageFactory for the Node

Returns:: this NodeConfiguration

Definition at line 394 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setTcpRosAdvertiseAddressFactory ( AdvertiseAddressFactory tcpRosAdvertiseAddressFactory ) [inline]

See also:: TCPROS documentation

Parameters:

tcpRosAdvertiseAddressFactory the AdvertiseAddressFactory for the Node's TCPROS server

Returns:: this NodeConfiguration

Definition at line 472 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setTcpRosBindAddress ( BindAddress tcpRosBindAddress ) [inline]

See also:: TCPROS documentation

Parameters:

tcpRosBindAddress the BindAddress for the Node's TCPROS server

Definition at line 449 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setTimeProvider ( TimeProvider timeProvider ) [inline]

Sets the TimeProvider that Nodes will use. By default, the WallTimeProvider is used.

Parameters:

timeProvider the TimeProvider that Nodes will use

Definition at line 558 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setTopicDescriptionFactory ( TopicDescriptionFactory topicDescriptionFactory ) [inline]

Parameters:

topicDescriptionFactory the TopicDescriptionFactory for the Node

Returns:: this NodeConfiguration

Definition at line 409 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setTopicMessageFactory ( MessageFactory topicMessageFactory ) [inline]

Parameters:

topicMessageFactory the MessageFactory for the Node

Returns:: this NodeConfiguration

Definition at line 365 of file NodeConfiguration.java.

NodeConfiguration org.ros.node.NodeConfiguration.setXmlRpcAdvertiseAddressFactory ( AdvertiseAddressFactory xmlRpcAdvertiseAddressFactory ) [inline]