MetainfoSet.h

Go to the documentation of this file.

//===-- serialbox/core/frontend/stella/MetainfoSet.h --------------------------------*- C++ -*-===//
//
//                                    S E R I A L B O X
//
// This file is distributed under terms of BSD license.
// See LICENSE.txt for more information
//
//===------------------------------------------------------------------------------------------===//
//
//===------------------------------------------------------------------------------------------===//

#ifndef SERIALBOX_CORE_FRONTEND_STELLA_METAINFOSET_H
#define SERIALBOX_CORE_FRONTEND_STELLA_METAINFOSET_H

#include "serialbox/core/frontend/stella/ForwardDecl.h"
#include <boost/any.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/type_traits.hpp>
#include <utility>
#include <vector>

namespace serialbox {

namespace stella {

class MetainfoSet {
public:
  MetainfoSet();

  explicit MetainfoSet(const boost::shared_ptr<MetainfoMapImpl>& map);

  MetainfoSet(const MetainfoSet& other);

  MetainfoSet& operator=(const MetainfoSet& other);

  void Cleanup();

  std::vector<std::string> keys() const;

  bool HasKey(const std::string& key) const;

  void AddMetainfo(const std::string& key, const int& value);
  void AddMetainfo(const std::string& key, const bool& value);
  void AddMetainfo(const std::string& key, const float& value);
  void AddMetainfo(const std::string& key, const double& value);
  void AddMetainfo(const std::string& key, const std::string& value);
  void AddMetainfo(const std::string& key, const char* value) {
    AddMetainfo(key, std::string(value));
  }

  const boost::any& AsAny(const std::string& key) const;

  bool AsBool(const std::string& key) const;

  int AsInt(const std::string& key) const;

  float AsFloat(const std::string& key) const;

  double AsDouble(const std::string& key) const;

  template <typename RealType>
  RealType AsReal(const std::string& key) const {
    BOOST_STATIC_ASSERT(
        (boost::is_same<RealType, float>::value || boost::is_same<RealType, double>::value));

    if(boost::is_same<RealType, float>::value)
      return AsFloat(key);
    else if(boost::is_same<RealType, double>::value)
      return AsDouble(key);
  }

  std::string AsString(const std::string& key) const;

  std::string ToString() const;

  std::size_t size() const;

  bool operator==(const MetainfoSet& other) const;

  void setImpl(const boost::shared_ptr<MetainfoMapImpl>& metaInfoMap);

  boost::shared_ptr<MetainfoMapImpl>& getImpl();
  const boost::shared_ptr<MetainfoMapImpl>& getImpl() const;

private:
  boost::shared_ptr<MetainfoMapImpl> mapImpl_;
};

} // namespace stella

} // namespace serialbox

#endif