src/ModelAPI/ModelAPI_ResultParameter.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef MODELAPI_RESULTPARAMETER_H_
  22 #define MODELAPI_RESULTPARAMETER_H_
  23
  24 #include <ModelAPI.h>
  25 #include <ModelAPI_Result.h>
  26
  27 /**\class ModelAPI_ResultParameter
  28  * \ingroup DataModel
  29  * \brief The construction element result of a feature.
  30  *
  31  * Provides a shape that may be displayed in the viewer.
  32  * Intermediate, light result that in many cases produces a result on the fly.
  33  */
  34 class ModelAPI_ResultParameter : public ModelAPI_Result
  35 {
  36  public:
  37   /// Returns the group identifier of this result
  38   virtual std::string groupName()
  39   {
  40     return group();
  41   }
  42
  43   /// Returns the group identifier of this result
  44   inline static std::string group()
  45   {
  46     static std::string MY_GROUP = "Parameters";
  47     return MY_GROUP;
  48   }
  49   /// The computed value attribute Id
  50   inline static const std::string& VALUE()
  51   {
  52     static const std::string MY_VALUE_ID("Value");
  53     return MY_VALUE_ID;
  54   }
  55
  56   /// The computational error attribute Id
  57   inline static const std::string& STATE()
  58   {
  59     static const std::string MY_VALUE_ID("State");
  60     return MY_VALUE_ID;
  61   }
  62
  63   /// The generic initialization of attributes
  64   virtual void initAttributes() = 0;
  65
  66   /// Destructor
  67   MODELAPI_EXPORT ~ModelAPI_ResultParameter();
  68
  69 };
  70
  71 //! Pointer on feature object
  72 typedef std::shared_ptr<ModelAPI_ResultParameter> ResultParameterPtr;
  73
  74 #endif