b311480e |
1 | -- Created on: 1993-01-11 |
2 | -- Created by: CKY / Contract Toubro-Larsen ( Anand NATRAJAN ) |
3 | -- Copyright (c) 1993-1999 Matra Datavision |
4 | -- Copyright (c) 1999-2012 OPEN CASCADE SAS |
7fd59977 |
5 | -- |
b311480e |
6 | -- The content of this file is subject to the Open CASCADE Technology Public |
7 | -- License Version 6.5 (the "License"). You may not use the content of this file |
8 | -- except in compliance with the License. Please obtain a copy of the License |
9 | -- at http://www.opencascade.org and read it completely before using this file. |
7fd59977 |
10 | -- |
b311480e |
11 | -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its |
12 | -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France. |
7fd59977 |
13 | -- |
b311480e |
14 | -- The Original Code and all software distributed under the License is |
15 | -- distributed on an "AS IS" basis, without warranty of any kind, and the |
16 | -- Initial Developer hereby disclaims all such warranties, including without |
17 | -- limitation, any warranties of merchantability, fitness for a particular |
18 | -- purpose or non-infringement. Please see the License for the specific terms |
19 | -- and conditions governing the rights and limitations under the License. |
20 | |
7fd59977 |
21 | |
22 | class Flow from IGESAppli inherits IGESEntity |
23 | |
24 | ---Purpose: defines Flow, Type <402> Form <18> |
25 | -- in package IGESAppli |
26 | -- Represents a single signal or a single fluid flow path |
27 | -- starting from a starting Connect Point Entity and |
28 | -- including additional intermediate connect points. |
29 | |
30 | uses |
31 | |
32 | ConnectPoint from IGESDraw, |
33 | TextDisplayTemplate from IGESGraph, |
34 | HAsciiString from TCollection, |
35 | HArray1OfHAsciiString from Interface, |
36 | HArray1OfIGESEntity from IGESData, |
37 | HArray1OfConnectPoint from IGESDraw, |
38 | HArray1OfTextDisplayTemplate from IGESGraph |
39 | |
40 | raises OutOfRange |
41 | |
42 | is |
43 | |
44 | Create returns mutable Flow; |
45 | |
46 | -- Specific Methods pertaining to the class |
47 | |
48 | Init (me : mutable; |
49 | nbContextFlags : Integer; |
50 | aFlowType : Integer; |
51 | aFuncFlag : Integer; |
52 | allFlowAssocs : HArray1OfIGESEntity; |
53 | allConnectPoints : HArray1OfConnectPoint; |
54 | allJoins : HArray1OfIGESEntity; |
55 | allFlowNames : HArray1OfHAsciiString; |
56 | allTextDisps : HArray1OfTextDisplayTemplate; |
57 | allContFlowAssocs : HArray1OfIGESEntity); |
58 | ---Purpose : This method is used to set the fields of the class Flow |
59 | -- - nbContextFlags : Count of Context Flags, always = 2 |
60 | -- - aFlowType : Type of Flow, default = 0 |
61 | -- - aFuncFlag : Function Flag, default = 0 |
62 | -- - allFlowAssocs : Flow Associativity Entities |
63 | -- - allConnectPoints : Connect Point Entities |
64 | -- - allJoins : Join Entities |
65 | -- - allFlowNames : Flow Names |
66 | -- - allTextDisps : Text Display Template Entities |
67 | -- - allContFlowAssocs : Continuation Flow Associativity Entities |
68 | |
69 | OwnCorrect (me : mutable) returns Boolean; |
70 | ---Purpose : forces NbContextFalgs to 2, returns True if changed |
71 | |
72 | NbContextFlags (me) returns Integer; |
73 | ---Purpose : returns number of Count of Context Flags, always = 2 |
74 | |
75 | NbFlowAssociativities (me) returns Integer; |
76 | ---Purpose : returns number of Flow Associativity Entities |
77 | |
78 | NbConnectPoints (me) returns Integer; |
79 | ---Purpose : returns number of Connect Point Entities |
80 | |
81 | NbJoins (me) returns Integer; |
82 | ---Purpose : returns number of Join Entities |
83 | |
84 | NbFlowNames (me) returns Integer; |
85 | ---Purpose : returns number of Flow Names |
86 | |
87 | NbTextDisplayTemplates (me) returns Integer; |
88 | ---Purpose : returns number of Text Display Template Entities |
89 | |
90 | NbContFlowAssociativities (me) returns Integer; |
91 | ---Purpose : returns number of Continuation Flow Associativity Entities |
92 | |
93 | TypeOfFlow (me) returns Integer; |
94 | ---Purpose : returns Type of Flow = 0 : Not Specified (default) |
95 | -- 1 : Logical |
96 | -- 2 : Physical |
97 | |
98 | FunctionFlag (me) returns Integer; |
99 | ---Purpose : returns Function Flag = 0 : Not Specified (default) |
100 | -- 1 : Electrical Signal |
101 | -- 2 : Fluid Flow Path |
102 | |
103 | FlowAssociativity (me; Index : Integer) returns IGESEntity |
104 | raises OutOfRange; |
105 | ---Purpose : returns Flow Associativity Entity |
106 | -- raises exception if Index <= 0 or Index > NbFlowAssociativities() |
107 | |
108 | ConnectPoint (me; Index : Integer) returns ConnectPoint |
109 | raises OutOfRange; |
110 | ---Purpose : returns Connect Point Entity |
111 | -- raises exception if Index <= 0 or Index > NbConnectPoints() |
112 | |
113 | Join (me; Index : Integer) returns IGESEntity |
114 | raises OutOfRange; |
115 | ---Purpose : returns Join Entity |
116 | -- raises exception if Index <= 0 or Index > NbJoins() |
117 | |
118 | FlowName (me; Index : Integer) returns HAsciiString from TCollection |
119 | raises OutOfRange; |
120 | ---Purpose : returns Flow Name |
121 | -- raises exception if Index <= 0 or Index > NbFlowNames() |
122 | |
123 | TextDisplayTemplate (me; Index : Integer) returns TextDisplayTemplate |
124 | raises OutOfRange; |
125 | ---Purpose : returns Text Display Template Entity |
126 | -- raises exception if Index <= 0 or Index > NbTextDisplayTemplates() |
127 | |
128 | ContFlowAssociativity (me; Index : Integer) returns IGESEntity |
129 | raises OutOfRange; |
130 | ---Purpose : returns Continuation Flow Associativity Entity |
131 | -- raises exception if Index <= 0 or Index > NbContFlowAssociativities() |
132 | |
133 | fields |
134 | |
135 | -- |
136 | -- Class : IGESAppli_Flow |
137 | -- |
138 | -- Purpose : Declaration of variables specific to the definition |
139 | -- of the Class Flow. |
140 | -- |
141 | -- Reminder : A Flow instance is defined by : |
142 | -- - Count of Context Flags, always = 2 |
143 | -- - Type of Flow, default = 0 |
144 | -- - Function Flag, default = 0 |
145 | -- - Flow Associativity Entities |
146 | -- - Connect Point Entities |
147 | -- - Join Entities |
148 | -- - Flow Names |
149 | -- - Text Display Template Entities |
150 | -- - Continuation Flow Associativity Entities |
151 | |
152 | theNbContextFlags : Integer; |
153 | theTypeOfFlow : Integer; |
154 | theFunctionFlag : Integer; |
155 | theFlowAssociativities : HArray1OfIGESEntity; |
156 | theConnectPoints : HArray1OfConnectPoint; |
157 | theJoins : HArray1OfIGESEntity; |
158 | theFlowNames : HArray1OfHAsciiString; |
159 | theTextDisplayTemplates : HArray1OfTextDisplayTemplate; |
160 | theContFlowAssociativities : HArray1OfIGESEntity; |
161 | |
162 | end Flow; |