src/ModelAPI/ModelAPI_Result.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_Result.hxx
   4 // Created:     07 Jul 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef ModelAPI_Result_H_
   8 #define ModelAPI_Result_H_
   9
  10 #include "ModelAPI_Object.h"
  11 #include <GeomAPI_Shape.h>
  12
  13 class ModelAPI_Feature;
  14
  15 /**\class ModelAPI_Result
  16  * \ingroup DataModel
  17  * \brief The result of a feature.
  18  *
  19  * A generic class that .
  20  */
  21 class ModelAPI_Result : public ModelAPI_Object
  22 {
  23   bool myIsConcealed; ///< the result is concealed from the data tree (referenced by other objects)
  24  public:
  25    /// Returns true if the result is concealed from the data tree (referenced by other objects)
  26   inline bool isConcealed()
  27   {
  28     return myIsConcealed;
  29   }
  30
  31   /// Returns true if the result is concealed from the data tree (referenced by other objects)
  32   inline void setIsConcealed(const bool theValue)
  33   {
  34     myIsConcealed = theValue;
  35   }
  36
  37   /// To virtually destroy the fields of successors
  38   MODELAPI_EXPORT virtual ~ModelAPI_Result();
  39
  40   /// Returns the shape-result produced by this feature (or null if no shapes)
  41   MODELAPI_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  42 };
  43
  44 //! Pointer on feature object
  45 typedef std::shared_ptr<ModelAPI_Result> ResultPtr;
  46
  47 #endif