src/ModelAPI/ModelAPI_ResultParameter.h

   1 // Copyright (C) 2014-2023  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef MODELAPI_RESULTPARAMETER_H_
  21 #define MODELAPI_RESULTPARAMETER_H_
  22
  23 #include <ModelAPI.h>
  24 #include <ModelAPI_Result.h>
  25
  26 /**\class ModelAPI_ResultParameter
  27  * \ingroup DataModel
  28  * \brief The construction element result of a feature.
  29  *
  30  * Provides a shape that may be displayed in the viewer.
  31  * Intermediate, light result that in many cases produces a result on the fly.
  32  */
  33 class ModelAPI_ResultParameter : public ModelAPI_Result
  34 {
  35  public:
  36   /// Returns the group identifier of this result
  37   virtual std::string groupName()
  38   {
  39     return group();
  40   }
  41
  42   /// Returns the group identifier of this result
  43   inline static std::string group()
  44   {
  45     static std::string MY_GROUP = "Parameters";
  46     return MY_GROUP;
  47   }
  48   /// The computed value attribute Id
  49   inline static const std::string& VALUE()
  50   {
  51     static const std::string MY_VALUE_ID("Value");
  52     return MY_VALUE_ID;
  53   }
  54
  55   /// The computational error attribute Id
  56   inline static const std::string& STATE()
  57   {
  58     static const std::string MY_VALUE_ID("State");
  59     return MY_VALUE_ID;
  60   }
  61
  62   /// The generic initialization of attributes
  63   virtual void initAttributes() = 0;
  64
  65   /// Destructor
  66   MODELAPI_EXPORT ~ModelAPI_ResultParameter();
  67
  68 };
  69
  70 //! Pointer on feature object
  71 typedef std::shared_ptr<ModelAPI_ResultParameter> ResultParameterPtr;
  72
  73 #endif