IStructure.hpp

Go to the documentation of this file.

 
#ifndef ISTRUCTURE_HPP
#define ISTRUCTURE_HPP
 
#include "include/ModelMetadata.hpp"
#include "include/ModelState.hpp"
 
#include <boost/algorithm/string/predicate.hpp>
#include <string>
 
namespace Nextsim {
 
class IStructure {
public:
    IStructure() { }
    virtual ~IStructure() = default;
 
    //    virtual void init(const std::string& filePath) = 0;
 
    virtual ModelState getModelState(const std::string& filePath) = 0;
 
    virtual const std::string& structureType() const { return processedStructureName; }
    inline bool structureTypeCheck(const std::string& str) const
    {
        return boost::algorithm::iequals(structureType(), str);
    }
 
    virtual int nIceLayers() const = 0;
 
    //    virtual void dump(const std::string& filePath) const = 0;
 
    virtual void dumpModelState(
        const ModelState& state, const ModelMetadata& metadata, const std::string& filePath, bool isRestart) const = 0;
 
    // Node names in the default structure
 
    static const std::string metadataNodeName() { return "metadata"; }
    static const std::string dataNodeName() { return "data"; }
    static const std::string structureNodeName() { return "structure"; }
    static const std::string typeNodeName() { return "type"; }
 
private:
    const std::string processedStructureName = "none";
};
 
}
#endif /* ISTRUCTURE_HPP */