//                                               -*- C++ -*-
/**
 *  @brief Input file metadata for coupling
 *
 *  Copyright 2015-2024 EDF-Phimeca
 *
 *  This library is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This library 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef PERSALYS_COUPLINGINPUTFILE_HXX
#define PERSALYS_COUPLINGINPUTFILE_HXX

#include "persalys/PersalysPrivate.hxx"
#include "Input.hxx"

#include <openturns/Description.hxx>

namespace PERSALYS
{
class PERSALYS_BASE_API CouplingInputFile : public OT::PersistentObject
{
  CLASSNAME

public:
  /** Default constructor */
  explicit CouplingInputFile(const OT::String & templatePath = "");

  /** Virtual constructor */
  CouplingInputFile * clone() const override;

  /** Path accessor */
  void setPath(const OT::String & templatePath);
  OT::String getPath() const;

  /** Template path accessor */
  void setConfiguredPath(const OT::String & configuredPath);
  OT::String getConfiguredPath() const;

  /** Variables accessor */
  void setVariables(const OT::Description & variableNames,
                    const OT::Description & tokens,
                    const OT::Description & formats);
  OT::Description getVariableNames() const;
  OT::Description getTokens() const;
  OT::Description getFormats() const;

  /** Simulating input file creation */
  void simulateInput(VariableCollection varColl) const;

  /** String converter */
  OT::String __repr__() const override;

  /** Method save() stores the object through the StorageManager */
  void save(OT::Advocate & adv) const override;

  /** Method load() reloads the object from the StorageManager */
  void load(OT::Advocate & adv) override;

private:
  OT::String path_;
  OT::String configuredPath_;
  OT::Description variableNames_;
  OT::Description tokens_;
  OT::Description formats_;
};

}
#endif
