Salome HOME
Merge branch 'csgroup_IS2'
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_ImportResult.h
1 // Copyright (C) 2017-2021  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 FeaturesPlugin_ImportResult_H_
21 #define FeaturesPlugin_ImportResult_H_
22
23 #include "FeaturesPlugin.h"
24
25 #include <ModelAPI_Feature.h>
26 #include <ModelAPI_AttributeValidator.h>
27
28 /// \class FeaturesPlugin_ImportResult
29 /// \ingroup Plugins
30 /// \brief The Import Result feature allows the user to import one or several results
31 ///        from another Part.
32
33 class FeaturesPlugin_ImportResult : public ModelAPI_Feature
34 {
35 public:
36   /// Feature kind.
37   inline static const std::string& ID()
38   {
39     static const std::string MY_ID("ImportResult");
40     return MY_ID;
41   }
42
43   /// \return the kind of a feature.
44   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
45   {
46     static std::string MY_KIND = FeaturesPlugin_ImportResult::ID();
47     return MY_KIND;
48   }
49
50   /// Selection list attribute that contains all copied shapes selection.
51   inline static const std::string& OBJECTS()
52   {
53     static const std::string MY_OBJECTS("objects");
54     return MY_OBJECTS;
55   }
56
57   /// Performs the algorithm and stores results it in the data structure.
58   FEATURESPLUGIN_EXPORT virtual void execute();
59
60   /// Request for initialization of data model of the feature: adding all attributes.
61   FEATURESPLUGIN_EXPORT virtual void initAttributes();
62
63   /// Use plugin manager for features creation.
64   FeaturesPlugin_ImportResult() {}
65 };
66
67 /// \class FeaturesPlugin_ValidatorImportResults
68 /// \ingroup Validators
69 /// \brief A validator for selection of objects that may be imported:
70 ///        from another part, result bodies.
71 class FeaturesPlugin_ValidatorImportResults : public ModelAPI_AttributeValidator
72 {
73 public:
74   //! \return True if selection is valid.
75   //! \param[in] theAttribute the checked attribute.
76   //! \param[in] theArguments arguments of the attribute.
77   //! \param[out] theError error message.
78   virtual bool isValid(const AttributePtr& theAttribute,
79     const std::list<std::string>& theArguments, Events_InfoMessage& theError) const;
80 };
81
82 #endif