1 // Copyright (C) 2014-2020 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 FeaturesAPI_Pipe_H_
21 #define FeaturesAPI_Pipe_H_
23 #include "FeaturesAPI.h"
25 #include <FeaturesPlugin_Pipe.h>
27 #include <ModelHighAPI_Interface.h>
28 #include <ModelHighAPI_Macro.h>
30 class ModelHighAPI_Dumper;
31 class ModelHighAPI_Selection;
33 /// \class FeaturesAPI_Pipe
34 /// \ingroup CPPHighAPI
35 /// \brief Interface for Pipe feature.
36 class FeaturesAPI_Pipe: public ModelHighAPI_Interface
39 /// Constructor without values.
41 explicit FeaturesAPI_Pipe(const std::shared_ptr<ModelAPI_Feature>& theFeature);
43 /// Constructor with values.
45 explicit FeaturesAPI_Pipe(const std::shared_ptr<ModelAPI_Feature>& theFeature,
46 const std::list<ModelHighAPI_Selection>& theBaseObjects,
47 const ModelHighAPI_Selection& thePath);
49 /// Constructor with values.
51 explicit FeaturesAPI_Pipe(const std::shared_ptr<ModelAPI_Feature>& theFeature,
52 const std::list<ModelHighAPI_Selection>& theBaseObjects,
53 const ModelHighAPI_Selection& thePath,
54 const ModelHighAPI_Selection& theBiNoramal);
56 /// Constructor with values.
58 explicit FeaturesAPI_Pipe(const std::shared_ptr<ModelAPI_Feature>& theFeature,
59 const std::list<ModelHighAPI_Selection>& theBaseObjects,
60 const ModelHighAPI_Selection& thePath,
61 const std::list<ModelHighAPI_Selection>& theLocations);
65 virtual ~FeaturesAPI_Pipe();
67 INTERFACE_5(FeaturesPlugin_Pipe::ID(),
68 baseObjects, FeaturesPlugin_Pipe::BASE_OBJECTS_ID(),
69 ModelAPI_AttributeSelectionList, /** Base objects */,
70 path, FeaturesPlugin_Pipe::PATH_OBJECT_ID(),
71 ModelAPI_AttributeSelection, /** Path */,
72 creationMethod, FeaturesPlugin_Pipe::CREATION_METHOD(),
73 ModelAPI_AttributeString, /** Creation method */,
74 biNormal, FeaturesPlugin_Pipe::BINORMAL_ID(),
75 ModelAPI_AttributeSelection, /** Bi-Normal */,
76 locations, FeaturesPlugin_Pipe::LOCATIONS_ID(),
77 ModelAPI_AttributeSelectionList, /** Locations */)
79 /// Modify base attribute of the feature.
81 void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
83 /// Modify path attribute of the feature.
85 void setPath(const ModelHighAPI_Selection& thePath);
87 /// Modify creation method, base and path.
89 void setByBasePath(const std::list<ModelHighAPI_Selection>& theBaseObjects,
90 const ModelHighAPI_Selection& thePath);
92 /// Modify creation method, base, path and bi-normal.
94 void setByBasePathBiNormal(const std::list<ModelHighAPI_Selection>& theBaseObjects,
95 const ModelHighAPI_Selection& thePath,
96 const ModelHighAPI_Selection& theBiNoramal);
98 /// Modify creation method, base, path and locations.
100 void setByBasePathLocations(const std::list<ModelHighAPI_Selection>& theBaseObjects,
101 const ModelHighAPI_Selection& thePath,
102 const std::list<ModelHighAPI_Selection>& theLocations);
104 /// Dump wrapped feature
106 virtual void dump(ModelHighAPI_Dumper& theDumper) const;
109 /// Pointer on Pipe object.
110 typedef std::shared_ptr<FeaturesAPI_Pipe> PipePtr;
112 /// \ingroup CPPHighAPI
113 /// \brief Create Pipe feature.
115 PipePtr addPipe(const std::shared_ptr<ModelAPI_Document>& thePart,
116 const std::list<ModelHighAPI_Selection>& theBaseObjects,
117 const ModelHighAPI_Selection& thePath);
119 /// \ingroup CPPHighAPI
120 /// \brief Create Pipe feature.
122 PipePtr addPipe(const std::shared_ptr<ModelAPI_Document>& thePart,
123 const std::list<ModelHighAPI_Selection>& theBaseObjects,
124 const ModelHighAPI_Selection& thePath,
125 const ModelHighAPI_Selection& theBiNoramal);
127 /// \ingroup CPPHighAPI
128 /// \brief Create Pipe feature.
130 PipePtr addPipe(const std::shared_ptr<ModelAPI_Document>& thePart,
131 const std::list<ModelHighAPI_Selection>& theBaseObjects,
132 const ModelHighAPI_Selection& thePath,
133 const std::list<ModelHighAPI_Selection>& theLocations);
135 #endif // FeaturesAPI_Pipe_H_