0024624: Lost word in license statement in source files
[occt.git] / src / Aspect / Aspect_Edge.cdl
1 -- Created on: 1991-11-04
2 -- Created by: NW,JPB,CAL
3 -- Copyright (c) 1991-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 class Edge from Aspect
18
19         ---Version:
20
21         ---Purpose: This class allows the definition of an edge.
22
23         ---Keywords: Edge, Visible, Invisible, Border, Line, Face
24
25         ---Warning:
26         ---References:
27
28 uses
29
30         TypeOfEdge      from Aspect
31
32 raises
33
34         EdgeDefinitionError     from Aspect
35
36 is
37
38         Create
39                 returns Edge from Aspect;
40         ---Level: Public
41         ---Purpose: Creates an edge.
42
43         Create ( AIndex1, AIndex2       : Integer from Standard;
44                  AType                  : TypeOfEdge from Aspect )
45                 returns Edge from Aspect
46         ---Level: Public
47         ---Purpose: Creates an edge from an index of vertices
48         --          in a table of vertices.
49         --          <AType> indicates if this edge is seen or not.
50         --  Warning: Raises EdgeDefinitionError if AIndex1 == AIndex2.
51         raises EdgeDefinitionError from Aspect;
52
53         ---------------------------------------------------
54         -- Category: Methods to modify the class definition
55         ---------------------------------------------------
56
57         SetValues ( me                  : in out;
58                     AIndex1, AIndex2    : Integer from Standard;
59                     AType               : TypeOfEdge from Aspect )
60         ---Level: Public
61         ---Purpose: Updates the values of an edge <me>.
62         --  Warning: Raises EdgeDefinitionError if AIndex1 == AIndex2.
63         raises EdgeDefinitionError from Aspect;
64
65         ----------------------------
66         -- Category: Inquire methods
67         ----------------------------
68
69         Values ( me;
70                  AIndex1, AIndex2       : out Integer from Standard;
71                  AType                  : out TypeOfEdge from Aspect );
72         ---Level: Public
73         ---Purpose: Returns the index of the vertices and the
74         --          type of edge <me>.
75         ---Category: Inquire methods
76
77         FirstIndex ( me )
78                 returns Integer from Standard;
79         ---Level: Public
80         ---Purpose: Returns the index of the begin of the edge <me>.
81         ---Category: Inquire methods
82
83         LastIndex ( me )
84                 returns Integer from Standard;
85         ---Level: Public
86         ---Purpose: Returns the index of the end of the edge <me>.
87         ---Category: Inquire methods
88
89         Type ( me)
90                 returns TypeOfEdge from Aspect;
91         ---Level: Public
92         ---Purpose: Returns the type of the edge <me>.
93         ---Category: Inquire methods
94
95 --\f
96
97 fields
98
99 --
100 -- Class        :       Aspect_Edge
101 --
102 -- Purpose      :       Declaration of variables specific to edges
103 --
104 -- Reminder     :       An edge is defined by :
105 --                      - two vertices referenced by indices
106 --                      - its visibility
107 --
108
109         -- indices of the vertices
110         MyBegin         :       Integer from Standard;
111         MyEnd           :       Integer from Standard;
112
113         -- the visibility
114         MyVisibility    :       TypeOfEdge from Aspect;
115
116 end Edge;