TopicParticipant.java

/*
 * Copyright (C) 2011 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package org.ros.internal.node.topic;

import org.ros.namespace.GraphName;

/**
 * Represents a ROS topic.
 *
 * @see <a href="http://www.ros.org/wiki/Topics">Topics documentation</a>
 *
 * @author damonkohler@google.com (Damon Kohler)
 */
public interface TopicParticipant {

  /**
   * @return the name of the subscribed topic
   */
  GraphName getTopicName();

  /**
   * @return the message type (e.g. "std_msgs/String")
   */
  String getTopicMessageType();
}