src/Model/Model_ResultField.h

   1 // Copyright (C) 2014-2022  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 Model_ResultField_H_
  21 #define Model_ResultField_H_
  22
  23 #include "Model.h"
  24 #include <ModelAPI_ResultField.h>
  25 #include <vector>
  26
  27 /**\class Model_ResultField
  28  * \ingroup DataModel
  29  * \brief The fields result.
  30  *
  31  * Provides a compound of selected elements, without storage, one the fly.
  32  */
  33 class Model_ResultField : public ModelAPI_ResultField
  34 {
  35   std::shared_ptr<ModelAPI_Data> myOwnerData;  ///< data of owner of this result
  36 public:
  37
  38   class Model_FieldStep : public ModelAPI_ResultField::ModelAPI_FieldStep
  39   {
  40   public:
  41     Model_FieldStep(ModelAPI_ResultField* theParent, int theId)
  42       : ModelAPI_ResultField::ModelAPI_FieldStep(), myParent(theParent), myId(theId)
  43     {
  44       setData(myParent->data()); // it is not needed to have special data for the temporary
  45                                  // step object, but data must be "valid" for GUI checks
  46     };
  47
  48     virtual ModelAPI_ResultField* field() const { return myParent; }
  49
  50     virtual int id() const { return myId; }
  51
  52     virtual std::shared_ptr<ModelAPI_Document> document() const { return myParent->document(); }
  53
  54     /// Returns a GUI name of this step
  55     virtual std::wstring name();
  56
  57   private:
  58     ModelAPI_ResultField* myParent;
  59     int myId;
  60   };
  61
  62   /// Returns the parameters of color definition in the resources configuration manager
  63   MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  64                                             std::string& theDefault);
  65
  66   /// Returns the compound of selected entities
  67   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  68
  69   /// Returns number of steps
  70   MODEL_EXPORT virtual int stepsSize() const;
  71
  72   /// Returns a text line by its number
  73   /// \param theLine a number of line
  74   MODEL_EXPORT virtual std::string textLine(int theLine) const;
  75
  76   /// Returns step object
  77   /// \param theId an id of the object
  78   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_ResultField::ModelAPI_FieldStep>
  79     step(int theId) const;
  80
  81   /// Removes the stored builders
  82   MODEL_EXPORT virtual ~Model_ResultField();
  83
  84   /// To refresh the steps of a field
  85   MODEL_EXPORT virtual void updateSteps();
  86
  87 protected:
  88   /// Makes a body on the given feature data
  89   Model_ResultField(std::shared_ptr<ModelAPI_Data> theOwnerData);
  90
  91   friend class Model_Objects;
  92
  93 private:
  94
  95   std::vector<FieldStepPtr> mySteps;
  96 };
  97
  98 #endif