Salome HOME
Correction according to coding standards
[modules/shaper.git] / src / Model / Model_SelectionNaming.h
index 8a7fbfda02a7d9a844680e3f3115135512d411e0..ff49de7bc8b9e80357dbcbf57706bd513a480f79 100644 (file)
@@ -1,8 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        Model_SelectionNaming.h
-// Created:     11 Aug 2015
-// Author:      Mikhail PONIKAROV
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef Model_SelectionNaming_H_
 #define Model_SelectionNaming_H_
@@ -30,8 +44,8 @@ public:
 
   /// Produces the string-name for the selected shape
   std::string namingName(ResultPtr& theContext, std::shared_ptr<GeomAPI_Shape> theSubSh,
-    const std::string& theDefaultName);
-  
+    const std::string& theDefaultName, const bool theAnotherDoc);
+
   /// Makes a selection by the string-name
   /// \param theType string of the type of the shape
   /// \param theSubShapeName string-identifier of the selected shape
@@ -42,20 +56,33 @@ public:
     std::shared_ptr<Model_Document> theDoc, std::shared_ptr<GeomAPI_Shape>& theShapeToBeSelected,
     std::shared_ptr<ModelAPI_Result>& theCont);
 
-  /// Searches the face more appropriate to the given curves (with higher level of matched parameters)
+  /// Searches the face more appropriate to the given curves
+  /// (with higher level of matched parameters)
   /// \param theConstr construction result that contains one or several  faces
-  /// \param theCurves map from the face edges curves to orientation (-1 reversed, 0 unknown, 1 forward)
+  /// \param theCurves map from the face edges curves to orientation
+  ///                  (-1 reversed, 0 unknown, 1 forward)
+  /// \param theIsWire for wire algorithm isquite the same,
+  ///                  but if in face several wires, it returns the needed wire
   /// \returns faces fron this construction if found
   static std::shared_ptr<GeomAPI_Shape> findAppropriateFace(
-    std::shared_ptr<ModelAPI_Result>& theConstr, 
-    NCollection_DataMap<Handle(Geom_Curve), int>& theCurves);
+    std::shared_ptr<ModelAPI_Result>& theConstr,
+    NCollection_DataMap<Handle(Geom_Curve), int>& theCurves, const bool theIsWire);
 
   /// Returns orientation of the edge in the context shape
   static int edgeOrientation(const TopoDS_Shape& theContext, TopoDS_Edge& theEdge);
 
+  /// Returns the name of sketch sub-element, shortened by exclusion of some symbols and with added
+  /// the vertex position (if needed)
+  /// \param theConstr result with name - basis for the name
+  /// \param theEdgeVertexPos position of the vertex on edge: 1 - first , 2 - second
+  /// \returns the generated name
+  static std::string shortName(std::shared_ptr<ModelAPI_ResultConstruction>& theConstr,
+    const int theEdgeVertexPos = 0);
+
 protected:
   /// Gets the stored name from the document
-  std::string getShapeName(std::shared_ptr<Model_Document> theDoc, const TopoDS_Shape& theShape);
+  std::string getShapeName(std::shared_ptr<Model_Document> theDoc, const TopoDS_Shape& theShape,
+    ResultPtr& theContext, const bool theAnotherDoc, const bool theWholeContext);
 };
 
 #endif