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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
import OCP.STEPEdit
from typing import *
from typing import Iterable as iterable
from typing import Iterator as iterator
from numpy import float64
_Shape = Tuple[int, ...]
import OCP.IFSelect
import OCP.Interface
import OCP.Standard
import OCP.TColStd
import OCP.StepData
import io
import OCP.TCollection
__all__ = [
"STEPEdit",
"STEPEdit_EditContext",
"STEPEdit_EditSDR"
]
class STEPEdit():
"""
Provides tools to exploit and edit a set of STEP data : editors, selections ..
"""
@staticmethod
def NewModel_s() -> OCP.StepData.StepData_StepModel:
"""
Returns a new empty StepModel fit for STEP i.e. with its header determined from Protocol
"""
@staticmethod
def NewSelectPlacedItem_s() -> OCP.IFSelect.IFSelect_SelectSignature:
"""
Creates a Selection for Placed Items, i.e. MappedItem or ContextDependentShapeRepresentation, which itself refers to a RepresentationRelationship with possible subtypes (Shape... and/or ...WithTransformation) By default in the whole StepModel
"""
@staticmethod
def NewSelectSDR_s() -> OCP.IFSelect.IFSelect_SelectSignature:
"""
Creates a Selection for ShapeDefinitionRepresentation By default searches among root entities
"""
@staticmethod
def NewSelectShapeRepr_s() -> OCP.IFSelect.IFSelect_SelectSignature:
"""
Creates a Selection for ShapeRepresentation and its sub-types, plus ContextDependentShapeRepresentation (which is not a sub-type of ShapeRepresentation) By default in the whole StepModel
"""
@staticmethod
def Protocol_s() -> OCP.Interface.Interface_Protocol:
"""
Returns a Protocol fit for STEP (creates the first time)
"""
@staticmethod
def SignType_s() -> OCP.IFSelect.IFSelect_Signature:
"""
Returns a SignType fit for STEP (creates the first time)
"""
def __init__(self) -> None: ...
pass
class STEPEdit_EditContext(OCP.IFSelect.IFSelect_Editor, OCP.Standard.Standard_Transient):
"""
EditContext is an Editor fit for Product Definition Context (one per Model) , i.e. : - ProductDefinition - ApplicationProtocolDefinition - ProductRelatedProductCategoryEditContext is an Editor fit for Product Definition Context (one per Model) , i.e. : - ProductDefinition - ApplicationProtocolDefinition - ProductRelatedProductCategoryEditContext is an Editor fit for Product Definition Context (one per Model) , i.e. : - ProductDefinition - ApplicationProtocolDefinition - ProductRelatedProductCategory
"""
def Apply(self,form : OCP.IFSelect.IFSelect_EditForm,ent : OCP.Standard.Standard_Transient,model : OCP.Interface.Interface_InterfaceModel) -> bool:
"""
None
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def EditMode(self,num : int) -> OCP.IFSelect.IFSelect_EditValue:
"""
Returns the edit mode of a Value
"""
def Form(self,readonly : bool,undoable : bool=True) -> OCP.IFSelect.IFSelect_EditForm:
"""
Builds and Returns an EditForm, empty (no data yet) Can be redefined to return a specific type of EditForm
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def IsList(self,num : int) -> bool:
"""
Tells if a parameter is a list
"""
def Label(self) -> OCP.TCollection.TCollection_AsciiString:
"""
None
"""
def ListEditor(self,num : int) -> OCP.IFSelect.IFSelect_ListEditor:
"""
Returns a ListEditor for a parameter which is a List Default returns a basic ListEditor for a List, a Null Handle if <num> is not for a List. Can be redefined
"""
def ListValue(self,form : OCP.IFSelect.IFSelect_EditForm,num : int) -> OCP.TColStd.TColStd_HSequenceOfHAsciiString:
"""
Returns the value of an EditForm as a List, for a given item If not a list, a Null Handle should be returned Default returns a Null Handle, because many Editors have no list to edit. To be redefined as required
"""
def Load(self,form : OCP.IFSelect.IFSelect_EditForm,ent : OCP.Standard.Standard_Transient,model : OCP.Interface.Interface_InterfaceModel) -> bool:
"""
None
"""
def MaxList(self,num : int) -> int:
"""
Returns max length allowed for a list = 0 means : list with no limit < 0 means : not a list
"""
def MaxNameLength(self,what : int) -> int:
"""
Returns the MaxLength of, according to what : <what> = -1 : length of short names <what> = 0 : length of complete names <what> = 1 : length of values labels
"""
def Name(self,num : int,isshort : bool=False) -> str:
"""
Returns the name of a Value (complete or short) from its ident Short Name can be empty
"""
def NameNumber(self,name : str) -> int:
"""
Returns the number (ident) of a Value, from its name, short or complete. If not found, returns 0
"""
def NbValues(self) -> int:
"""
Returns the count of Typed Values
"""
def PrintDefs(self,S : io.BytesIO,labels : bool=False) -> None:
"""
None
"""
def PrintNames(self,S : io.BytesIO) -> None:
"""
None
"""
def Recognize(self,form : OCP.IFSelect.IFSelect_EditForm) -> bool:
"""
None
"""
def SetList(self,num : int,max : int=0) -> None:
"""
Sets a parameter to be a List max < 0 : not for a list (set when starting) max = 0 : list with no length limit (default for SetList) max > 0 : list limited to <max> items
"""
def SetValue(self,num : int,typval : OCP.Interface.Interface_TypedValue,shortname : str='',accessmode : OCP.IFSelect.IFSelect_EditValue=IFSelect_EditValue.IFSelect_Editable) -> None:
"""
Sets a Typed Value for a given ident and short name, with an Edit Mode
"""
def StringValue(self,form : OCP.IFSelect.IFSelect_EditForm,num : int) -> OCP.TCollection.TCollection_HAsciiString:
"""
None
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def TypedValue(self,num : int) -> OCP.Interface.Interface_TypedValue:
"""
Returns a Typed Value from its ident
"""
def Update(self,form : OCP.IFSelect.IFSelect_EditForm,num : int,newval : OCP.TCollection.TCollection_HAsciiString,enforce : bool) -> bool:
"""
Updates the EditForm when a parameter is modified I.E. default does nothing, can be redefined, as follows : Returns True when done (even if does nothing), False in case of refuse (for instance, if the new value is not suitable) <num> is the rank of the parameter for the EDITOR itself <enforce> True means that protected parameters can be touched
"""
def UpdateList(self,form : OCP.IFSelect.IFSelect_EditForm,num : int,newlist : OCP.TColStd.TColStd_HSequenceOfHAsciiString,enforce : bool) -> bool:
"""
Acts as Update, but when the value is a list
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class STEPEdit_EditSDR(OCP.IFSelect.IFSelect_Editor, OCP.Standard.Standard_Transient):
"""
EditSDR is an Editor fit for a Shape Definition Representation which designates a Product DefinitionEditSDR is an Editor fit for a Shape Definition Representation which designates a Product DefinitionEditSDR is an Editor fit for a Shape Definition Representation which designates a Product Definition
"""
def Apply(self,form : OCP.IFSelect.IFSelect_EditForm,ent : OCP.Standard.Standard_Transient,model : OCP.Interface.Interface_InterfaceModel) -> bool:
"""
None
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def EditMode(self,num : int) -> OCP.IFSelect.IFSelect_EditValue:
"""
Returns the edit mode of a Value
"""
def Form(self,readonly : bool,undoable : bool=True) -> OCP.IFSelect.IFSelect_EditForm:
"""
Builds and Returns an EditForm, empty (no data yet) Can be redefined to return a specific type of EditForm
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def IsList(self,num : int) -> bool:
"""
Tells if a parameter is a list
"""
def Label(self) -> OCP.TCollection.TCollection_AsciiString:
"""
None
"""
def ListEditor(self,num : int) -> OCP.IFSelect.IFSelect_ListEditor:
"""
Returns a ListEditor for a parameter which is a List Default returns a basic ListEditor for a List, a Null Handle if <num> is not for a List. Can be redefined
"""
def ListValue(self,form : OCP.IFSelect.IFSelect_EditForm,num : int) -> OCP.TColStd.TColStd_HSequenceOfHAsciiString:
"""
Returns the value of an EditForm as a List, for a given item If not a list, a Null Handle should be returned Default returns a Null Handle, because many Editors have no list to edit. To be redefined as required
"""
def Load(self,form : OCP.IFSelect.IFSelect_EditForm,ent : OCP.Standard.Standard_Transient,model : OCP.Interface.Interface_InterfaceModel) -> bool:
"""
None
"""
def MaxList(self,num : int) -> int:
"""
Returns max length allowed for a list = 0 means : list with no limit < 0 means : not a list
"""
def MaxNameLength(self,what : int) -> int:
"""
Returns the MaxLength of, according to what : <what> = -1 : length of short names <what> = 0 : length of complete names <what> = 1 : length of values labels
"""
def Name(self,num : int,isshort : bool=False) -> str:
"""
Returns the name of a Value (complete or short) from its ident Short Name can be empty
"""
def NameNumber(self,name : str) -> int:
"""
Returns the number (ident) of a Value, from its name, short or complete. If not found, returns 0
"""
def NbValues(self) -> int:
"""
Returns the count of Typed Values
"""
def PrintDefs(self,S : io.BytesIO,labels : bool=False) -> None:
"""
None
"""
def PrintNames(self,S : io.BytesIO) -> None:
"""
None
"""
def Recognize(self,form : OCP.IFSelect.IFSelect_EditForm) -> bool:
"""
None
"""
def SetList(self,num : int,max : int=0) -> None:
"""
Sets a parameter to be a List max < 0 : not for a list (set when starting) max = 0 : list with no length limit (default for SetList) max > 0 : list limited to <max> items
"""
def SetValue(self,num : int,typval : OCP.Interface.Interface_TypedValue,shortname : str='',accessmode : OCP.IFSelect.IFSelect_EditValue=IFSelect_EditValue.IFSelect_Editable) -> None:
"""
Sets a Typed Value for a given ident and short name, with an Edit Mode
"""
def StringValue(self,form : OCP.IFSelect.IFSelect_EditForm,num : int) -> OCP.TCollection.TCollection_HAsciiString:
"""
None
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def TypedValue(self,num : int) -> OCP.Interface.Interface_TypedValue:
"""
Returns a Typed Value from its ident
"""
def Update(self,form : OCP.IFSelect.IFSelect_EditForm,num : int,newval : OCP.TCollection.TCollection_HAsciiString,enforce : bool) -> bool:
"""
Updates the EditForm when a parameter is modified I.E. default does nothing, can be redefined, as follows : Returns True when done (even if does nothing), False in case of refuse (for instance, if the new value is not suitable) <num> is the rank of the parameter for the EDITOR itself <enforce> True means that protected parameters can be touched
"""
def UpdateList(self,form : OCP.IFSelect.IFSelect_EditForm,num : int,newlist : OCP.TColStd.TColStd_HSequenceOfHAsciiString,enforce : bool) -> bool:
"""
Acts as Update, but when the value is a list
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
|
