src/Model/Model_ResultField.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef Model_ResultField_H_
  22 #define Model_ResultField_H_
  23
  24 #include "Model.h"
  25 #include <ModelAPI_ResultField.h>
  26 #include <vector>
  27
  28 /**\class Model_ResultField
  29  * \ingroup DataModel
  30  * \brief The fields result.
  31  *
  32  * Provides a compound of selected elements, without storage, one the fly.
  33  */
  34 class Model_ResultField : public ModelAPI_ResultField
  35 {
  36   std::shared_ptr<ModelAPI_Data> myOwnerData;  ///< data of owner of this result
  37 public:
  38
  39   class Model_FieldStep : public ModelAPI_ResultField::ModelAPI_FieldStep
  40   {
  41   public:
  42     Model_FieldStep(ModelAPI_ResultField* theParent, int theId)
  43       : myParent(theParent), myId(theId) {};
  44
  45     virtual ModelAPI_ResultField* field() const { return myParent; }
  46
  47     virtual int id() const { return myId; }
  48
  49   private:
  50     ModelAPI_ResultField* myParent;
  51     int myId;
  52   };
  53
  54   /// Retuns the parameters of color definition in the resources config manager
  55   MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  56                                             std::string& theDefault);
  57
  58   /// Returns the compound of selected entities
  59   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  60
  61   /// Returns number of steps
  62   MODEL_EXPORT virtual int stepsSize() const;
  63
  64   /// Returns a text line by its number
  65   /// \param theLine a number of line
  66   MODEL_EXPORT virtual std::string textLine(int theLine) const;
  67
  68   /// Returns step object
  69   /// \param theId an id of the object
  70   MODEL_EXPORT virtual ModelAPI_ResultField::ModelAPI_FieldStep* step(int theId) const;
  71
  72   /// Removes the stored builders
  73   MODEL_EXPORT virtual ~Model_ResultField();
  74
  75 protected:
  76   /// Makes a body on the given feature data
  77   Model_ResultField(std::shared_ptr<ModelAPI_Data> theOwnerData);
  78
  79   friend class Model_Objects;
  80
  81 private:
  82   void updateSteps();
  83
  84   std::vector<ModelAPI_FieldStep*> mySteps;
  85 };
  86
  87 #endif