Champ_Proto.h

/****************************************************************************
* Copyright (c) 2024, CEA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*****************************************************************************/
 
#ifndef Champ_Proto_included
#define Champ_Proto_included
 
#include <TRUSTTab.h>
 
class Nom;
class Entree;
 
/*! @brief class Champ_Proto Class representing a Field prototype.
 *
 * All classes
 *      representing fields derive from Champ_proto. Champ_proto offers
 *      classic methods on fields (min, max, norm, += ...)
 *      but does not contain a member representing data.
 *      Most Champ_proto methods call methods of the same name
 *      of a DoubleTab object returned by the abstract method
 *      of Champ_proto valeurs().
 *
 * @sa Champ_base DoubleTab, Abstract class., Abstract method:, DoubleTab& valeurs()=0, const DoubleTab& valeurs() const
 */
class Champ_Proto
{
public:
  virtual ~Champ_Proto() { }
  virtual DoubleTab& valeurs()=0;
  virtual const DoubleTab& valeurs() const =0;
 
  /* by default, these methods return valeurs() */
  virtual inline DoubleTab& valeurs(double temps) { return valeurs(); }
  virtual inline const DoubleTab& valeurs(double temps) const { return valeurs(); }
 
  virtual inline  DoubleTab& futur(int i = 1) { return valeurs(); }
  virtual inline const DoubleTab& futur(int i = 1) const { return valeurs(); }
 
  virtual inline DoubleTab& passe(int i = 1) { return valeurs(); }
  virtual inline const DoubleTab& passe(int i = 1) const { return valeurs(); }
 
  int lire_dimension(Entree&, const Nom&);
  int lire_dimension(int dim, const Nom& le_nom_);
 
  // XXX : Elie Saikali : that's forbidden !! that's all
  double operator()(int i, int j) const = delete;
  double& operator()(int i, int j) = delete;
  double operator()(int i) const = delete;
  double& operator()(int i) = delete;
};
 
#endif /* Champ_Proto_included */