MessageFieldCollection.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (C) 2014 by Ralf Kaestner                                        *
 * ralf.kaestner@gmail.com                                                    *
 *                                                                            *
 * This program is free software; you can redistribute it and/or modify       *
 * it under the terms of the Lesser GNU General Public License as published by*
 * the Free Software Foundation; either version 3 of the License, or          *
 * (at your option) any later version.                                        *
 *                                                                            *
 * This program is distributed in the hope that it will be useful,            *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the               *
 * Lesser GNU General Public License for more details.                        *
 *                                                                            *
 * You should have received a copy of the Lesser GNU General Public License   *
 * along with this program. If not, see <http://www.gnu.org/licenses/>.       *
 ******************************************************************************/

#ifndef VARIANT_TOPIC_TOOLS_MESSAGE_FIELD_COLLECTION_H
#define VARIANT_TOPIC_TOOLS_MESSAGE_FIELD_COLLECTION_H

#include <vector>

#include <boost/unordered_map.hpp>

#include <ros/ros.h>

#include <variant_topic_tools/Forwards.h>

namespace variant_topic_tools {
  template <typename T> class MessageFieldCollection {
  public:
    MessageFieldCollection();

    MessageFieldCollection(const MessageFieldCollection<T>& src);

    virtual ~MessageFieldCollection();

    size_t getNumFields() const;

    MessageField<T>& getField(int index);

    const MessageField<T>& getField(int index) const;

    MessageField<T>& getField(const std::string& name);

    const MessageField<T>& getField(const std::string& name) const;

    bool hasField(const std::string& name) const;

    bool isEmpty() const;

    void appendField(const MessageField<T>& field);

    void appendField(const std::string& name, const T& value = T());

    void merge(const MessageFieldCollection<T>& collection);

    virtual void clear();

    virtual void write(std::ostream& stream, const std::string& indent =
      std::string()) const;

    MessageField<T>& operator[](int index);

    const MessageField<T>& operator[](int index) const;

    MessageField<T>& operator[](const std::string& name);

    const MessageField<T>& operator[](const std::string& name) const;

    MessageFieldCollection<T>& operator+=(const MessageField<T>& field);

    bool operator==(const MessageFieldCollection<T>& collection) const;

    bool operator!=(const MessageFieldCollection<T>& collection) const;

  protected:
    typedef boost::shared_ptr<MessageField<T> > MessageFieldPtr;

    typedef boost::weak_ptr<MessageField<T> > MessageFieldWPtr;

    std::vector<MessageFieldPtr> fieldsInOrder;

    boost::unordered_map<std::string, MessageFieldPtr> fieldsByName;

    MessageField<T>& getField(const std::string& name, size_t pos) const;

    bool hasField(const std::string& name, size_t pos) const;
  };

  template <typename T> std::ostream& operator<<(std::ostream& stream,
    const MessageFieldCollection<T>& collection);
};

#include <variant_topic_tools/MessageFieldCollection.tpp>

#endif