MessageField.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_H
#define VARIANT_TOPIC_TOOLS_MESSAGE_FIELD_H

#include <boost/type_traits.hpp>

#include <ros/ros.h>

#include <variant_topic_tools/MessageFieldCollection.h>
#include <variant_topic_tools/MessageFieldTypeTraits.h>
#include <variant_topic_tools/MessageType.h>

namespace variant_topic_tools {
  template <typename T> class MessageField :
    public MessageFieldCollection<T> {
  public:
    MessageField(const std::string& name = std::string(), const
      T& value = T());
    
    MessageField(const MessageField<T>& src);
    
    virtual ~MessageField();
    
    void setName(const std::string& name);
    
    const std::string& getName() const;
    
    void setValue(const T& value);
    
    T& getValue();
    
    const T& getValue() const;
    
    bool isValid() const;
    
    void clear();
    
    void write(std::ostream& stream, const std::string& indent =
      std::string()) const;
    
    bool operator==(const MessageField<T>& field) const;
    
    bool operator!=(const MessageField<T>& field) const;
    
  protected:
    std::string name;
    
    T value;
    
    template <typename U> static bool isValid(const U& value, typename boost::
      enable_if_c<MessageFieldTypeTraits::HasIsValid<U>::value>::type* = 0);
    
    template <typename U> static bool isValid(const U& value, typename boost::
      disable_if_c<MessageFieldTypeTraits::HasIsValid<U>::value>::type* = 0);
    
    template <typename U> static void writeValue(std::ostream& stream, const
      U& value, typename boost::enable_if<boost::has_left_shift<std::ostream,
      const U&> >::type* = 0);
    
    template <typename U> static void writeValue(std::ostream& stream, const
      U& value, typename boost::disable_if<boost::has_left_shift<std::ostream,
      const U&> >::type* = 0);
  };
  
  template <typename T> std::ostream& operator<<(std::ostream& stream,
    const MessageField<T>& messageField);
};

#include <variant_topic_tools/MessageField.tpp>

#endif