b311480e |
1 | -- Created on: 1993-01-09 |
2 | -- Created by: CKY / Contract Toubro-Larsen (Anand NATRAJAN) |
3 | -- Copyright (c) 1993-1999 Matra Datavision |
973c2be1 |
4 | -- Copyright (c) 1999-2014 OPEN CASCADE SAS |
7fd59977 |
5 | -- |
973c2be1 |
6 | -- This file is part of Open CASCADE Technology software library. |
7fd59977 |
7 | -- |
d5f74e42 |
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 |
973c2be1 |
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. |
7fd59977 |
13 | -- |
973c2be1 |
14 | -- Alternatively, this file may be used under the terms of Open CASCADE |
15 | -- commercial license or contractual agreement. |
7fd59977 |
16 | |
17 | class GeneralSymbol from IGESDimen inherits IGESEntity |
18 | |
19 | ---Purpose: defines General Symbol, Type <228>, Form <0-3,5001-9999> |
20 | -- in package IGESDimen |
21 | -- Consists of zero or one (Form 0) or one (all other |
22 | -- forms), one or more geometry entities which define |
23 | -- a symbol, and zero, one or more associated leaders. |
24 | |
25 | uses |
26 | |
27 | HArray1OfIGESEntity from IGESData, |
28 | LeaderArrow from IGESDimen, |
29 | GeneralNote from IGESDimen, |
30 | HArray1OfLeaderArrow from IGESDimen |
31 | |
32 | raises OutOfRange |
33 | |
34 | is |
35 | |
6e33d3ce |
36 | Create returns GeneralSymbol; |
7fd59977 |
37 | |
38 | -- Specific Methods pertaining to the class |
39 | |
40 | Init (me : mutable; |
41 | aNote : GeneralNote; |
42 | allGeoms : HArray1OfIGESEntity; |
43 | allLeaders : HArray1OfLeaderArrow); |
44 | ---Purpose : This method is used to set the fields of the class |
45 | -- GeneralSymbol |
46 | -- - aNote : General Note, null for form 0 |
47 | -- - allGeoms : Geometric Entities |
48 | -- - allLeaders : Leader Arrows |
49 | |
50 | SetFormNumber (me : mutable; form : Integer) raises OutOfRange; |
51 | ---Purpose : Changes FormNumber (indicates the Nature of the Symbole) |
52 | -- Error if not in ranges [0-3] or [> 5000] |
53 | |
54 | |
55 | HasNote (me) returns Boolean; |
56 | ---Purpose : returns True if there is associated General Note Entity |
57 | |
58 | Note (me) returns GeneralNote; |
59 | ---Purpose : returns Null handle for form 0 only |
60 | |
61 | NbGeomEntities (me) returns Integer; |
62 | ---Purpose : returns number of Geometry Entities |
63 | |
64 | GeomEntity (me; Index : Integer) returns IGESEntity |
65 | raises OutOfRange; |
66 | ---Purpose : returns the Index'th Geometry Entity |
67 | -- raises exception if Index <= 0 or Index > NbGeomEntities() |
68 | |
69 | NbLeaders (me) returns Integer; |
70 | ---Purpose : returns number of Leaders or zero if not specified |
71 | |
72 | LeaderArrow (me; Index : Integer) returns LeaderArrow |
73 | raises OutOfRange; |
74 | ---Purpose : returns the Index'th Leader Arrow |
75 | -- raises exception if Index <= 0 or Index > NbLeaders() |
76 | |
77 | fields |
78 | |
79 | -- |
80 | -- Class : IGESDimen_GeneralSymbol |
81 | -- |
82 | -- Purpose : Declaration of variables specific to the definition |
83 | -- of the Class GeneralSymbol. |
84 | -- |
85 | -- Reminder : A GeneralSymbol instance is defined by : |
86 | -- - A General Note |
87 | -- - An array of Geometry Entities |
88 | -- - An array of Leader Arrows |
89 | |
90 | theNote : GeneralNote; |
91 | theGeoms : HArray1OfIGESEntity; |
92 | theLeaders : HArray1OfLeaderArrow; |
93 | |
94 | end GeneralSymbol; |