ctu.nengoros.comm.nodeFactory.modem

Interface ModemContainer

All Superinterfaces:

ExternalNodeContainer

All Known Implementing Classes:

ModContainer

public interface ModemContainer
extends ExternalNodeContainer

Method Summary

Methods

Modifier and Type	Method and Description
org.ros.node.NodeConfiguration	getConfiguration() Deprecated.
org.ros.node.ConnectedNode	getConnectedNode() The most important method is getConnectedNode(), which provides factory for ROS publishers/subscribers, this factory is used by coders/decoders to create own origins/ terminations.
Modem	getModem() Modem is interface for a ROS/Nengo modem
NodeGroup	getMyGroup() In case that someone would like to access to group data (e.g.
void	reset() This may not be supported so far
void	resetModem() This calls (typical Nengo method) reset on modem in the container.
void	setModem(Modem myModem) Set modem to this ModemContainer

Methods inherited from interface ctu.nengoros.comm.nodeFactory.ExternalNodeContainer

getName, isRunning, start, stop, useLogging

Method Detail

reset

void reset()

This may not be supported so far

Specified by:

reset in interface ExternalNodeContainer

getModem

Modem getModem()

Modem is interface for a ROS/Nengo modem

Returns:

modem (ROS node) of this ModemContainer

setModem

void setModem(Modem myModem)

Set modem to this ModemContainer

Parameters:

myModem - modem to be used

getConnectedNode

org.ros.node.ConnectedNode getConnectedNode()
                                            throws ConnectionException

The most important method is getConnectedNode(), which provides factory for ROS publishers/subscribers, this factory is used by coders/decoders to create own origins/ terminations. In order to obtain ConnectedNode, the modem has to be already launched.

Returns:

factory for ROS publishers/subscribers

Throws:

ConnectionException

resetModem

void resetModem()

This calls (typical Nengo method) reset on modem in the container. This method should call myGroup.reset() method, which resets all nodes in the group, including this one

getMyGroup

NodeGroup getMyGroup()

In case that someone would like to access to group data (e.g. vivae agents)

Returns:

group that I belong to

getConfiguration

@Deprecated
org.ros.node.NodeConfiguration getConfiguration()

Deprecated.

Configuration which launches the node (name, namespace..)

Returns:

node cofiguration of the launched Modem