1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
-- File: StepData_PDescr.cdl
-- Created: Fri Jan 3 11:08:27 1997
-- Author: Christian CAILLET
-- <cky@heliox.paris1.matra-dtv.fr>
---Copyright: Matra Datavision 1997
class PDescr from StepData inherits TShared
---Purpose : This class is intended to describe the authorized form for a
-- parameter, as a type or a value for a field
--
-- A PDescr firstly describes a type, which can be SELECT, i.e.
-- have several members
uses CString, Type from Standard, AsciiString from TCollection,
Check from Interface,
EnumTool from StepData, Field from StepData, EDescr from StepData
is
Create returns PDescr;
SetName (me : mutable; name : CString);
Name (me) returns CString;
-- basic settings
Kind (me) returns Integer is private;
SetSelect (me : mutable);
---Purpose : Declares this PDescr to be a Select, hence to have members
-- <me> itself can be the first member
AddMember (me : mutable; member : PDescr);
---Purpose : Adds a member to a SELECT description
SetMemberName (me : mutable; memname : CString);
---Purpose : Sets a name for SELECT member. To be used if a member is for
-- an immediate type
SetInteger (me : mutable);
---Purpose : Sets <me> for an Integer value
SetReal (me : mutable);
---Purpose : Sets <me> for a Real value
SetString (me : mutable);
---Purpose : Sets <me> for a String value
SetBoolean (me : mutable);
---Purpose : Sets <me> for a Boolean value (false,true)
SetLogical (me : mutable);
---Purpose : Sets <me> for a Logical value (false,true,unknown)
SetEnum (me : mutable);
---Purpose : Sets <me> for an Enum value
-- Then, call AddEnumDef ordered from the first one (value 0)
AddEnumDef (me : mutable; enumdef : CString);
---Purpose : Adds an enum value as a string
SetType (me : mutable; atype : Type from Standard);
---Purpose : Sets <me> for an Entity which must match a Type (early-bound)
SetDescr (me : mutable; dscnam : CString);
---Purpose : Sets <me> for a Described Entity, whose Description must match
-- the type name <dscnam>
AddArity (me : mutable; arity : Integer = 1);
---Purpose : Adds an arity count to <me>, by default 1
-- 1 : a simple field passes to a LIST/ARRAY etc
-- or a LIST to a LIST OF LIST
-- 2 : a simple field passes to a LIST OF LIST
SetArity (me : mutable; arity : Integer = 1);
---Purpose : Directly sets the arity count
-- 0 : simple field
-- 1 : LIST or ARRAY etc
-- 2 : LIST OF LIST
-- complements
SetFrom (me : mutable; other : PDescr);
---Purpose : Sets <me> as <other> but duplicated
-- Hence, some definition may be changed
SetOptional (me : mutable; opt : Boolean = Standard_True);
---Purpose : Sets/Unsets <me> to accept undefined values
SetDerived (me : mutable; der : Boolean = Standard_True);
---Purpose : Sets/Unsets <me> to be for a derived field
SetField (me : mutable; name : CString; rank : Integer);
---Purpose : Sets <me> to describe a field of an entity
-- With a name and a rank
-- querying
IsSelect (me) returns Boolean;
---Purpose : Tells if <me> is for a SELECT
Member (me; name : CString) returns PDescr;
---Purpose : For a SELECT, returns the member whose name matches <name>
-- To this member, the following question can then be asked
-- Null Handle if <name> not matched or <me> not a SELECT
--
-- Remark : not to be asked for an entity type
-- Hence, following IsInteger .. Enum* only apply on <me> and
-- require Member
-- While IsType applies on <me> and all Select Members
IsInteger (me) returns Boolean;
---Purpose : Tells if <me> is for an Integer
IsReal (me) returns Boolean;
---Purpose : Tells if <me> is for a Real value
IsString (me) returns Boolean;
---Purpose : Tells if <me> is for a String value
IsBoolean (me) returns Boolean;
---Purpose : Tells if <me> is for a Boolean value (false,true)
IsLogical (me) returns Boolean;
---Purpose : Tells if <me> is for a Logical value (false,true,unknown)
IsEnum (me) returns Boolean;
---Purpose : Tells if <me> is for an Enum value
-- Then, call AddEnumDef ordered from the first one (value 0)
-- Managed by an EnumTool
EnumMax (me) returns Integer;
---Purpose : Returns the maximum integer for a suitable value (count - 1)
EnumValue (me; name : CString) returns Integer;
---Purpose : Returns the numeric value found for an enum text
-- The text must be in capitals and limited by dots
-- A non-suitable text gives a negative value to be returned
EnumText (me; val : Integer) returns CString;
---Purpose : Returns the text which corresponds to a numeric value,
-- between 0 and EnumMax. It is limited by dots
IsEntity (me) returns Boolean;
---Purpose : Tells if <me> is for an Entity, either Described or CDL Type
IsType (me; atype : Type from Standard) returns Boolean;
---Purpose : Tells if <me> is for an entity of a given CDL type (early-bnd)
-- (works for <me> + nexts if <me> is a Select)
Type (me) returns Type from Standard;
---Purpose : Returns the type to match (IsKind), for a CDL Entity
-- (else, null handle)
IsDescr (me; descr : EDescr from StepData) returns Boolean;
---Purpose : Tells if <me> is for a Described entity of a given EDescr
-- (does this EDescr match description name ?). For late-bnd
-- (works for <me> + nexts if <me> is a Select)
DescrName (me) returns CString;
---Purpose : Returns the description (type name) to match, for a Described
-- (else, empty string)
Arity (me) returns Integer;
---Purpose : Returns the arity of <me>
Simple (me) returns PDescr;
---Purpose : For a LIST or LIST OF LIST, Returns the PDescr for the simpler
-- PDescr. Else, returns <me>
-- This allows to have different attributes for Optional for
-- instance, on a field, and on the parameter of a LIST :
-- [OPTIONAL] LIST OF [OPTIONAL] ...
IsOptional (me) returns Boolean;
---Purpose : Tells if <me> is Optional
IsDerived (me) returns Boolean;
---Purpose : Tells if <me> is Derived
IsField (me) returns Boolean;
---Purpose : Tells if <me> is a Field. Else it is a Type
FieldName (me) returns CString;
FieldRank (me) returns Integer;
Check (me; afild : Field; ach : in out Check) is virtual;
---Purpose : Semantic Check of a Field : does it complies with the given
-- description ?
fields
thename : AsciiString from TCollection;
thesel : Integer; -- 0 no 1 entity 2 immediate 3 heterog. 4 unknown
thesnam : AsciiString from TCollection;
thenext : PDescr; -- list of members
thekind : Integer; -- as Field
theenum : EnumTool from StepData;
thetype : Type from Standard;
thednam : AsciiString from TCollection;
thearit : Integer;
thefrom : PDescr; -- for SetFrom
theopt : Boolean;
theder : Boolean;
thefnam : AsciiString from TCollection;
thefnum : Integer;
end PDescr;
|
