1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef Model_ResultField_H_
21 #define Model_ResultField_H_
24 #include <ModelAPI_ResultField.h>
27 /**\class Model_ResultField
29 * \brief The fields result.
31 * Provides a compound of selected elements, without storage, one the fly.
33 class Model_ResultField : public ModelAPI_ResultField
35 std::shared_ptr<ModelAPI_Data> myOwnerData; ///< data of owner of this result
38 class Model_FieldStep : public ModelAPI_ResultField::ModelAPI_FieldStep
41 Model_FieldStep(ModelAPI_ResultField* theParent, int theId)
42 : ModelAPI_ResultField::ModelAPI_FieldStep(), myParent(theParent), myId(theId)
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
48 virtual ModelAPI_ResultField* field() const { return myParent; }
50 virtual int id() const { return myId; }
52 virtual std::shared_ptr<ModelAPI_Document> document() const { return myParent->document(); }
54 /// Returns a GUI name of this step
55 virtual std::string name();
58 ModelAPI_ResultField* myParent;
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);
66 /// Returns the compound of selected entities
67 MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
69 /// Returns number of steps
70 MODEL_EXPORT virtual int stepsSize() const;
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;
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;
81 /// Removes the stored builders
82 MODEL_EXPORT virtual ~Model_ResultField();
84 /// To refresh the steps of a field
85 MODEL_EXPORT virtual void updateSteps();
88 /// Makes a body on the given feature data
89 Model_ResultField(std::shared_ptr<ModelAPI_Data> theOwnerData);
91 friend class Model_Objects;
95 std::vector<FieldStepPtr> mySteps;