src/Model/Model_ResultField.h

   1 // Copyright (C) 2014-2019  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       : myParent(theParent), myId(theId) {};
  43
  44     virtual ModelAPI_ResultField* field() const { return myParent; }
  45
  46     virtual int id() const { return myId; }
  47
  48   private:
  49     ModelAPI_ResultField* myParent;
  50     int myId;
  51   };
  52
  53   /// Retuns the parameters of color definition in the resources config manager
  54   MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  55                                             std::string& theDefault);
  56
  57   /// Returns the compound of selected entities
  58   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  59
  60   /// Returns number of steps
  61   MODEL_EXPORT virtual int stepsSize() const;
  62
  63   /// Returns a text line by its number
  64   /// \param theLine a number of line
  65   MODEL_EXPORT virtual std::string textLine(int theLine) const;
  66
  67   /// Returns step object
  68   /// \param theId an id of the object
  69   MODEL_EXPORT virtual ModelAPI_ResultField::ModelAPI_FieldStep* step(int theId) const;
  70
  71   /// Removes the stored builders
  72   MODEL_EXPORT virtual ~Model_ResultField();
  73
  74 protected:
  75   /// Makes a body on the given feature data
  76   Model_ResultField(std::shared_ptr<ModelAPI_Data> theOwnerData);
  77
  78   friend class Model_Objects;
  79
  80 private:
  81   void updateSteps();
  82
  83   std::vector<ModelAPI_FieldStep*> mySteps;
  84 };
  85
  86 #endif