Savepoint.h

Go to the documentation of this file.

//===-- serialbox/core/frontend/stella/Savepoint.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_SAVEPOINT_H
#define SERIALBOX_CORE_FRONTEND_STELLA_SAVEPOINT_H

#include "serialbox/core/frontend/stella/ForwardDecl.h"
#include "serialbox/core/frontend/stella/MetainfoSet.h"
#include <iosfwd>
#include <string>

namespace serialbox {

namespace stella {

class Savepoint {
public:
  Savepoint();

  void Init(const std::string& name);

  explicit Savepoint(const boost::shared_ptr<SavepointImpl>& savepointImpl);

  Savepoint(const Savepoint& other);

  Savepoint& operator=(const Savepoint& other);

  void AddMetainfo(const std::string& key, const bool& value);
  void AddMetainfo(const std::string& key, const int& 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 std::string& name() const;

  const MetainfoSet& metainfo() const { return metainfo_; }

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

  bool operator!=(const Savepoint& other) const;

  std::string ToString() const;

  friend std::ostream& operator<<(std::ostream& out, const Savepoint& sp);

  void setImpl(const boost::shared_ptr<SavepointImpl>& savepointImpl);

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

private:
  boost::shared_ptr<SavepointImpl> savepointImpl_;
  MetainfoSet metainfo_; // Allow refrence access
};

} // namespace stella

} // namespace serialbox

#endif