//                                               -*- C++ -*-
/**
 *  @brief Class to define inputs for the physical models
 *
 *  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_INPUT_HXX
#define PERSALYS_INPUT_HXX

#include "Variable.hxx"

#include <openturns/Distribution.hxx>

namespace PERSALYS
{
class PERSALYS_BASE_API Input : public Variable
{
  CLASSNAME

public:
  /** Default constructor */
  Input();
  /** Constructor with parameters */
  Input(const OT::String& name);
  /** Constructor with parameters */
  Input(const OT::String& name, const double& value, const OT::Distribution& distribution,
        const OT::String& description = "", const OT::String& unit = "");
  /** Constructor with parameters */
  Input(const OT::String& name, const OT::Distribution& distribution,
        const OT::String& description = "", const OT::String& unit = "");
  /** Constructor with parameters */
  Input(const OT::String& name, const double& value,
        const OT::String& description = "", const OT::String& unit = "");

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

  /** Comparison operator */
  OT::Bool operator ==(const Input & other) const;

  OT::Distribution getDistribution() const;
  void setDistribution(const OT::Distribution & distribution);

  OT::UnsignedInteger getDistributionParametersType() const;
  void setDistributionParametersType(const OT::UnsignedInteger & distributionParametersType);

  double getFiniteDifferenceStep() const;
  void setFiniteDifferenceStep(const double& step);

  bool isStochastic() const;
  void setStochastic(const bool stoch);

  OT::String getPythonScript() const override;

  /** 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;

protected:
  OT::String getDistributionPythonScript() const;

private:
  bool isStochastic_ = false;
  OT::Distribution distribution_;
  OT::UnsignedInteger distributionParametersType_ = 0;
  double finiteDifferenceStep_ = 0.0;
};
typedef OT::Collection<Input> InputCollection;
}
#endif
