ICaseFunction.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2023 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ICaseFunction.h                                             (C) 2000-2023 */
/*                                                                           */
/* Interface d'une fonction du jeu de données.                               */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ICASEFUNCTION_H
#define ARCANE_CORE_ICASEFUNCTION_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ARCANE_CORE_EXPORT ICaseFunction
{
  ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS();
 
 public:
 
  enum eParamType
  {
    ParamUnknown =0, 
    ParamReal = 1, 
    ParamInteger = 2 
  };
  enum eValueType
  {
    ValueUnknown = 0, 
    ValueReal = 1, 
    ValueInteger = 2, 
    ValueBool = 3, 
    ValueString = 4,  
    ValueReal3 = 5  
  };
 
 public:
  
  // NOTE: Laisse temporairement ce destructeur publique tant
  // qu'on appelle explicitement ce destructeur mais avec le compteur
  // de référence cela ne sera normalement plus le cas.
  virtual ~ICaseFunction() = default; 
 
 public:
 
  virtual String name() const =0;
 
  virtual void setName(const String& new_name) =0;
 
  virtual eParamType paramType() const =0;
 
  virtual void setParamType(eParamType type) =0;
 
  virtual eValueType valueType() const =0;
 
  virtual void setValueType(eValueType type) =0;
 
  virtual void setTransformValueFunction(const String& str) =0;
 
  virtual String transformValueFunction() const =0;
 
  virtual void setTransformParamFunction(const String& str) =0;
 
  virtual String transformParamFunction() const =0;
 
  virtual bool checkIfValid() const =0;
 
  virtual void setDeltatCoef(Real v) =0;
 
  virtual Real deltatCoef() const =0;
 
 public:
 
  virtual void value(Real param,Real& v) const =0;
 
  virtual void value(Real param,Integer& v) const =0;
 
  virtual void value(Real param,bool& v) const =0;
 
  virtual void value(Real param,String& v) const =0;
 
  virtual void value(Real param,Real3& v) const =0;
 
  virtual void value(Integer param,Real& v) const =0;
 
  virtual void value(Integer param,Integer& v) const =0;
 
  // Valeur \a v de l'option pour le paramètre \a param.
  virtual void value(Integer param,bool& v) const =0;
 
  virtual void value(Integer param,String& v) const =0;
 
  virtual void value(Integer param,Real3& v) const =0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif