src/ModelAPI/ModelAPI_ResultBody.h

   1 // File:        ModelAPI_ResultBody.hxx
   2 // Created:     07 Jul 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef ModelAPI_ResultBody_HeaderFile
   6 #define ModelAPI_ResultBody_HeaderFile
   7
   8 #include "ModelAPI_Result.h"
   9 #include <GeomAPI_Shape.h>
  10
  11 #include <string>
  12
  13 /**\class ModelAPI_ResultBody
  14  * \ingroup DataModel
  15  * \brief The body (shape) result of a feature.
  16  *
  17  * Provides a shape that may be displayed in the viewer.
  18  * May provide really huge results, so, working with this kind
  19  * of result must be optimized.
  20  */
  21 class ModelAPI_ResultBody : public ModelAPI_Result
  22 {
  23 public:
  24   /// Returns the group identifier of this result
  25   virtual std::string groupName() {
  26     return group();
  27   }
  28
  29   /// Returns the group identifier of this result
  30   static std::string group()
  31   {static std::string MY_GROUP = "Bodies"; return MY_GROUP;}
  32
  33   /// Stores the shape (called by the execution method).
  34   virtual void store(const boost::shared_ptr<GeomAPI_Shape>& theShape) = 0;
  35   /// Returns the shape-result produced by this feature
  36   virtual boost::shared_ptr<GeomAPI_Shape> shape() = 0;
  37
  38   /// To virtually destroy the fields of successors
  39   virtual ~ModelAPI_ResultBody() {}
  40
  41 protected:
  42   /// Use plugin manager for features creation: this method is
  43   /// defined here only for SWIG-wrapping
  44   ModelAPI_ResultBody()
  45   {}
  46 };
  47
  48 //! Pointer on feature object
  49 typedef boost::shared_ptr<ModelAPI_ResultBody> ResultBodyPtr;
  50
  51 #endif