src/ModelAPI/ModelAPI_ResultParameter.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_ResultParameter.h
   4 // Created:     07 Jul 2014
   5 // Author:      Vitaly SMETANNIKOV
   6
   7 #ifndef MODELAPI_RESULTPARAMETER_H_
   8 #define MODELAPI_RESULTPARAMETER_H_
   9
  10 #include "ModelAPI_Result.h"
  11
  12 /**\class ModelAPI_ResultParameter
  13  * \ingroup DataModel
  14  * \brief The construction element result of a feature.
  15  *
  16  * Provides a shape that may be displayed in the viewer.
  17  * Intermediate, light result that in many cases produces a result on the fly.
  18  */
  19 class ModelAPI_ResultParameter : public ModelAPI_Result
  20 {
  21  public:
  22   /// Returns the group identifier of this result
  23   virtual std::string groupName()
  24   {
  25     return group();
  26   }
  27
  28   /// Returns the group identifier of this result
  29   inline static std::string group()
  30   {
  31     static std::string MY_GROUP = "Parameters";
  32     return MY_GROUP;
  33   }
  34
  35   inline static const std::string& VALUE()
  36   {
  37     static const std::string MY_VALUE_ID("Value");
  38     return MY_VALUE_ID;
  39   }
  40
  41   inline static const std::string& STATE()
  42   {
  43     static const std::string MY_VALUE_ID("State");
  44     return MY_VALUE_ID;
  45   }
  46
  47   virtual void initAttributes() = 0;
  48
  49 };
  50
  51 //! Pointer on feature object
  52 typedef std::shared_ptr<ModelAPI_ResultParameter> ResultParameterPtr;
  53
  54 #endif