0024510: Remove unused local variables
[occt.git] / src / GccAna / GccAna_Pnt2dBisec.cdl
CommitLineData
b311480e 1-- Created on: 1991-04-03
2-- Created by: Remi GILET
3-- Copyright (c) 1991-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
973c2be1 8-- This library is free software; you can redistribute it and / or modify it
9-- under the terms of the GNU Lesser General Public 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class Pnt2dBisec
18
19from GccAna
20
21 ---Purpose: This class implements the algorithms used to
22 -- create the bisecting line between two 2d points
23 -- Describes functions for building a bisecting line between two 2D points.
24 -- The bisecting line between two points is the bisector of
25 -- the segment which joins the two points, if these are not coincident.
26 -- The algorithm does not find a solution if the two points are coincident.
27 -- A Pnt2dBisec object provides a framework for:
28 -- - defining the construction of the bisecting line,
29 -- - implementing the construction algorithm, and consulting the result.
30
31uses Pnt2d from gp,
32 Lin2d from gp
33
34raises NotDone from StdFail
35
36is
37
38Create(Point1 : Pnt2d from gp ;
39 Point2 : Pnt2d from gp ) returns Pnt2dBisec;
40
41 ---Purpose: Constructs a bisecting line between the points Point1 and Point2.
42
43IsDone(me) returns Boolean from Standard
44is static;
45 ---Purpose: Returns true (this construction algorithm never fails).
46
47HasSolution(me) returns Boolean from Standard
48is static;
49 ---Purpose: Returns true if this algorithm has a solution, i.e. if the
50 -- two points are not coincident.
51
52ThisSolution(me) returns Lin2d from gp
53raises NotDone
54is static;
55 ---Purpose : Returns a line, representing the solution computed by this algorithm.
56
57fields
58
59 WellDone : Boolean from Standard;
60 -- True if the algorithm succeeded.
61
62 HasSol : Boolean from Standard;
63 -- True if there is a solution.
64
65 linsol : Lin2d from gp;
66 ---Purpose : The solutions.
67
68end Pnt2dBisec;
69
70