0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / BRepBuilderAPI / BRepBuilderAPI_EdgeError.hxx
1 // Created on: 1993-07-06
2 // Created by: Remi LEQUETTE
3 // Copyright (c) 1993-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _BRepBuilderAPI_EdgeError_HeaderFile
18 #define _BRepBuilderAPI_EdgeError_HeaderFile
19
20 //! Indicates the outcome of the
21 //! construction of an edge, i.e. whether it has been successful or
22 //! not, as explained below:
23 //! -      BRepBuilderAPI_EdgeDone No    error occurred; The edge is
24 //! correctly built.
25 //! -      BRepBuilderAPI_PointProjectionFailed No parameters were given but
26 //! the projection of the 3D points on the curve failed. This
27 //! happens when the point distance to the curve is greater than
28 //! the precision value.
29 //! -      BRepBuilderAPI_ParameterOutOfRange
30 //! The given parameters are not in the parametric range
31 //! C->FirstParameter(), C->LastParameter()
32 //! -      BRepBuilderAPI_DifferentPointsOnClosedCurve
33 //! The two vertices or points are the extremities of a closed
34 //! curve but have different locations.
35 //! -      BRepBuilderAPI_PointWithInfiniteParameter
36 //! A finite coordinate point was associated with an infinite
37 //! parameter (see the Precision package for a definition of    infinite values).
38 //! -      BRepBuilderAPI_DifferentsPointAndParameter
39 //! The distance between the 3D point and the point evaluated
40 //! on the curve with the parameter is greater than the precision.
41 //! -      BRepBuilderAPI_LineThroughIdenticPoints
42 //! Two identical points were given to define a line (construction
43 //! of an edge without curve); gp::Resolution is used for the    confusion test.
44 enum BRepBuilderAPI_EdgeError
45 {
46 BRepBuilderAPI_EdgeDone,
47 BRepBuilderAPI_PointProjectionFailed,
48 BRepBuilderAPI_ParameterOutOfRange,
49 BRepBuilderAPI_DifferentPointsOnClosedCurve,
50 BRepBuilderAPI_PointWithInfiniteParameter,
51 BRepBuilderAPI_DifferentsPointAndParameter,
52 BRepBuilderAPI_LineThroughIdenticPoints
53 };
54
55 #endif // _BRepBuilderAPI_EdgeError_HeaderFile