SimulatorSignatureXMLReader.hpp

Go to the documentation of this file.

/*
 
  This file is part of OpenFLUID software
  Copyright(c) 2021-2026, INRAE
 
 
 == GNU General Public License Usage ==
 
  OpenFLUID is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  OpenFLUID 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
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.
 
 
 == Other Usage ==
 
  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/
 
 
/**
  @file SimulatorSignatureXMLReader.hpp
 
  @author Jean-Christophe FABRE <jean-christophe.fabre@inrae.fr>
*/
 
 
#ifndef __OPENFLUID_WARESDEV_SIMULATORSIGNATUREXMLREADER_HPP__
#define __OPENFLUID_WARESDEV_SIMULATORSIGNATUREXMLREADER_HPP__
 
 
#include <openfluid/ware/SimulatorSignature.hpp>
#include <openfluid/dllexport.hpp>
 
 
namespace openfluid { namespace waresdev {
 
 
/**
  Read of ghost simulators signatures in old XML format
*/
class OPENFLUID_API SimulatorSignatureXMLReader
{
  public:
 
    static inline std::string const FormatVersion = "ghostsim 1";
 
    SimulatorSignatureXMLReader() = delete;
 
    /**
      Loads a signature of a ghost simulator from a file
      @param[in] FilePath The path to the file to load
      @param[out] Signature The signature loaded from file
      @return true if the signature was successfully loaded, false otherwise
    */
    static bool loadFromFile(const std::string& FilePath, openfluid::ware::SimulatorSignature& Signature);
};
 
 
} }  // namespaces
 
 
#endif /* __OPENFLUID_WARESDEV_SIMULATORSIGNATUREXMLREADER_HPP__ */