org.ros.internal.node.topic
Class DefaultTopicParticipant

java.lang.Object
  org.ros.internal.node.topic.DefaultTopicParticipant

All Implemented Interfaces:

TopicParticipant

Direct Known Subclasses:

DefaultPublisher, DefaultSubscriber

public abstract class DefaultTopicParticipant
extends java.lang.Object
implements TopicParticipant

Base definition of a TopicSystemState.

Constructor Summary

DefaultTopicParticipant(TopicDeclaration topicDeclaration)

Method Summary

TopicDeclaration	getTopicDeclaration()
java.util.List<java.lang.String>	getTopicDeclarationAsList()
java.util.Map<java.lang.String,java.lang.String>	getTopicDeclarationHeader()
java.lang.String	getTopicMessageType()
GraphName	getTopicName()
abstract void	signalOnMasterRegistrationFailure() Signal that the TopicSystemState failed to register with the master.
abstract void	signalOnMasterRegistrationSuccess() Signal that the TopicSystemState successfully registered with the master.
abstract void	signalOnMasterUnregistrationFailure() Signal that the TopicSystemState failed to unregister with the master.
abstract void	signalOnMasterUnregistrationSuccess() Signal that the TopicSystemState successfully unregistered with the master.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultTopicParticipant

public DefaultTopicParticipant(TopicDeclaration topicDeclaration)

Method Detail

getTopicDeclaration

public TopicDeclaration getTopicDeclaration()

Returns:

the TopicDeclaration of this TopicParticipant

getTopicDeclarationAsList

public java.util.List<java.lang.String> getTopicDeclarationAsList()

getTopicName

public GraphName getTopicName()

Specified by:

getTopicName in interface TopicParticipant

Returns:

the name of the subscribed topic

getTopicMessageType

public java.lang.String getTopicMessageType()

Specified by:

getTopicMessageType in interface TopicParticipant

Returns:

the message type (e.g. "std_msgs/String")

getTopicDeclarationHeader

public java.util.Map<java.lang.String,java.lang.String> getTopicDeclarationHeader()

Returns:

the connection header for the TopicSystemState

signalOnMasterRegistrationSuccess

public abstract void signalOnMasterRegistrationSuccess()

Signal that the TopicSystemState successfully registered with the master.

signalOnMasterRegistrationFailure

public abstract void signalOnMasterRegistrationFailure()

Signal that the TopicSystemState failed to register with the master.

signalOnMasterUnregistrationSuccess

public abstract void signalOnMasterUnregistrationSuccess()

Signal that the TopicSystemState successfully unregistered with the master.

signalOnMasterUnregistrationFailure

public abstract void signalOnMasterUnregistrationFailure()

Signal that the TopicSystemState failed to unregister with the master.