Objet_U_With_Params.h

/****************************************************************************
* Copyright (c) 2026, 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 Objet_U_With_Params_included
#define Objet_U_With_Params_included
 
#include <Objet_U.h>
class Param;
 
 
/*! @brief Inherits from Objet_U, adds the very common method set_param for the Objet_U hierarchy
 *
 *  All classes introducing new keywords/parameters must inherit from this class and not Objet_U.
 *  The goal is to promote the use of param.ajouter and move toward a more consistent grammar
 *  for TRUST datasets.
 *
 *  readOn cannot be overriden when inheriting from this class.
 *
 *  Method set_param can be overriden to register params with param.ajouter
 *
 *  Method validate_params is provided for override if complex attribute validation is needed
 *  It is called right after reading the params, and should not modify the objects.
 *
 *
 *  Classes inheriting from Objet_U_With_Params must use one of the macros:
 *  Declare_base_with_param or Declare_instanciable_with_param.
 *  They do not declare the readOn function, which is not possible when deriving from this class.
 *
 *
 */
class Objet_U_With_Params : public Objet_U
{
  Declare_base_with_param(Objet_U_With_Params);
protected:
  Entree& readOn(Entree&) override final;
 
  /*! @brief Called in the readOn of Objet_U_With_Params, after reading the params
   *
   * Should check the coherence and validity of the params, throwing/exiting accordingly
   * At this point, we are still const.
   *
   */
  virtual void validate_params() const {};
 
private:
  virtual Entree& __readOn_Impl_DO_NOT_OVERRIDE_UNLESS_THE_WORLD_IS_ENDING(Entree&);
};
 
#endif /* Objet_U_With_Params_included */