aurostd_xserialization.h

Go to the documentation of this file.

// ***************************************************************************
// *                                                                         *
// *           Aflow STEFANO CURTAROLO - Duke University 2003-2025           *
// *                                                                         *
// ***************************************************************************
 
#ifndef AFLOW_XSERIALIZATION_H
#define AFLOW_XSERIALIZATION_H
 
#include <filesystem>
#include <string>
 
#include "aurostd_xfile.h"
 
namespace aurostd::JSON {
  struct object;
}

template <typename T /* <: */> class JsonSerializable {
  friend aurostd::JSON::object;
 
public:
  virtual ~JsonSerializable() = default;
 
  [[nodiscard]] aurostd::JSON::object dumpToJson() const;
  [[nodiscard]] std::string dumpToString() const;
  void dumpToFile(const std::filesystem::path &path, aurostd::compression_type compression = aurostd::compression_type::None) const;
 
  static T loadFromJson(const aurostd::JSON::object &jo);
  static T loadFromFile(const std::filesystem::path &path);
  static T loadFromString(const std::string &content);
 
protected:
  virtual T deserialize(const aurostd::JSON::object &jo) = 0;
  [[nodiscard]] virtual aurostd::JSON::object serialize() const = 0;
  [[nodiscard]] virtual std::string getJsonID() const = 0;
 
private:
  [[nodiscard]] aurostd::JSON::object dumpJsonMeta() const;
  void checkClassID(const aurostd::JSON::object &jo) const;
};
 
#include "aurostd_xserialization.tpp" // NOLINT / template implementation
 
#endif // AFLOW_XSERIALIZATION_H