0027206: Inconsistent and obsolete information in persistence documentation and Relea...
[occt.git] / dox / user_guides / step / step.md
1 STEP processor  {#occt_user_guides__step}
2 ========================
3
4 @tableofcontents
5
6 @section occt_step_1 Introduction
7
8 STEP is more and more widely used to exchange data between various software, involved in CAD, PDM, Analysis, etc... STEP is far more than an "exchange standard" : it provides a technology and a set of methodologies to describe the data to exchange in a modular and upgradeable way. Regarding OCCT, this mostly applies to CAD data but it is not a limitation, other kinds of data for specific applications can be addressed too.
9
10 @figure{/user_guides/step/images/step_image002.png, "Image imported from STEP"}
11
12 Open Cascade allows its users to employ STEP in the following domains:
13 * Exchange of data for technical applications, following the state-of-the-art definitions and rules;
14 * Extension of case coverage, according to specific needs or to the evolution of general business uses;
15 * Expertise in data architecture of an application, to get experience from STEP definitions and make easier the mapping to them, for a better interoperability with outer world.
16
17 This manual is intended to provide technical documentation on the Open CASCADE Technology (**OCCT**) STEP processor and to help Open CASCADE Technology users with the use of the STEP processor (to read and write STEP files). 
18
19 Only geometrical, topological STEP entities (shapes) and assembly structures are translated by the basic translator described in sections 2 to 6. Data that cannot be translated on this level are also loaded from a STEP file and can be translated later. XDE STEP translator (see section 7 @ref occt_step_7 "Reading from and writing to XDE") translates names, colors, layers, validation properties and other data associated with shapes and assemblies into XDE document. 
20
21 File translation is performed in the programming mode, via C++ calls. 
22
23 @ref occt_user_guides__shape_healing "Shape Healing" toolkit provides tools to heal various problems, which may be encountered in translated shapes, and to make them valid in Open CASCADE. The Shape Healing is smoothly connected to STEP translator using the same API, only the names of API packages change.
24
25 For testing the STEP component in DRAW Test Harness, a set of commands for reading and writing STEP files and analysis of relevant data are provided by the *TKXSDRAW* plugin. 
26
27 See also our <a href="http://www.opencascade.com/content/tutorial-learning">E-learning & Training</a> offerings.
28
29 @subsection occt_step_1_1 STEP Exchanges in Open Cascade technology
30
31 Beyond the upper level API, which is fitted for an easy end-use, the STEP exchange functions enter in the general frame of Exchanges in Open Cascade, adapted for STEP:
32
33 * Specific packages for Data definition and checking;
34 * Physical Access supported by Drivers (Part 21 file access is embedded);
35 * Conversion to/from Open Cascade or applicative data supported by drivers (OCC-BREP and XDE ard basically provided);
36 * Tools for analysis, filtering, etc... including DRAW commands.
37
38 These modules share common architecture and capabilities with other exchange modules of Open Cascade, like Shape Healing. Also, built-in Viewer and Converter (as Plugin for Netscape, Internet Explorer ..), are based on the same technology.
39
40 In addition, Open Cascade provides tools to process models described using STEP: to reflect EXPRESS descriptions, to read, write and check data, to analyze the whole models ... Their key features are:
41
42 * Modularity by sets of data types, which can be hierarchized to reflect the original modularity describing the resources and application protocols;
43 * Implementation as C++ classes, providing comprehensive access to their members;
44 * Early binding is basically used, providing good performance, easy installation and use as well as the capability to support non-compiled descriptions.
45
46 This provides a natural way to deal with non-supported protocols when they share common definitions, as for geometry, which can then be exploited. The common frame, as the already supported data types, give a good foundation to go towards new uses of STEP, either on data definition (protocols from ISO or from industrial consortia) or on mapping with applicative data.
47
48
49 @subsection occt_step_1_2 STEP Interface
50
51 The STEP interface reads STEP files produced in accordance with STEP Application Protocol 214 (Conformance Class 2 both CD and DIS versions of schema) and translates them to Open CASCADE Technology models. STEP Application Protocol 203 is also supported.
52
53 The STEP interface also translates OCCT models to STEP files. STEP files that are produced by this interface conform to STEP AP 203 or AP 214 (Conformance Class 2, either CD or DIS version of the schema) depending on the user's option.
54
55 Basic interface reads and writes geometrical, topological STEP data and assembly structures. 
56
57 The interface is able to translate one entity, a group of entities or a whole file.
58
59 Other kinds of data such as colors, validation properties, layers, names and the structure of assemblies can be read or written with the help of XDE tools: <i> STEPCAFControl_Reader</i> and <i> STEPCAFControl_Writer</i>. 
60
61 To choose a translation mode when exporting to a STEP format, use <i> STEPControl_STEPModelType</i>.
62
63 There is a set of parameters that concern the translation and can be set before the beginning of the translation.
64
65 Please, note:
66 * a STEP model is a STEP file that has been loaded into memory;
67 * all references to shapes indicate OCCT shapes unless otherwise explicitly stated;
68 * a root entity is the highest level entity of any given type, i.e. an entity that is not referenced by any other one.
69
70 @section occt_step_2 Reading STEP
71 @subsection occt_step_2_1 Procedure
72 You can translate a STEP file into an OCCT shape in the following steps: 
73 1. load the file, 
74 2. check file consistency, 
75 3. set the translation parameters, 
76 4. perform the translation, 
77 5. fetch the results. 
78 @subsection occt_step_2_2 Domain covered
79 @subsubsection occt_step_2_2_1 Assemblies
80 The **ProSTEP Round Table Agreement Log** (version July 1998), item 21, defines two alternatives for the implementation of assembly structure representations: using *mapped_item entities* and using *representation_relationship_with_transformation* entities. Both these alternative representations are recognized and processed at reading. On writing, the second alternative is always employed. 
81
82 Handling of assemblies is implemented in two separate levels: firstly STEP assembly structures are translated into OCCT shapes, and secondly the OCCT shape representing the assembly is converted into any data structure intended for representing assemblies (for example, OCAF). 
83
84 The first part of this document describes the basic STEP translator implementing translation of the first level, i.e. translation to OCCT Shapes. On this level, the acyclic graph representing the assembly structure in a STEP file is mapped into the structure of nested *TopoDS_Compounds* in Open CASCADE Technology. The (sub)assemblies become (sub)compounds containing shapes which are the results of translating components of that (sub)assembly. The sharing of components of assemblies is preserved as Open CASCADE Technology sharing of subshapes in compounds. 
85
86 The attributive information attached to assembly components in a STEP file (such as names and descriptions of products, colors, layers etc.) can be translatd after the translation of the shape itself by parsing the STEP model (loaded in memory). Several tools from the package STEPConstruct provide functionalities to read styles (colors), validation properties, product information etc. 
87 Implementation of the second level of translation (conversion to XDE data structure) is provided by XDE STEP translator. 
88
89 @subsubsection occt_step_2_2_2 Shape representations
90 Length units, plane angle units and the uncertainty value are taken from *shape_representation* entities. This data is used in the translation process. 
91
92 The types of STEP representation entities that are recognized are: 
93   * advanced_brep_shape_representation 
94   * faceted_brep_shape_representation 
95   * manifold_surface_shape_representation 
96   * geometrically_bounded_wireframe_shape_representation 
97   * geometrically_bounded_surface_shape_representation 
98   * hybrid representations (shape_representation containing models of different type) 
99   
100 @subsubsection occt_step_2_2_3 Topological entities
101 The types of STEP topological entities that can be translated are: 
102   * vertices 
103   * edges 
104   * loops 
105   * faces 
106   * shells 
107   * solids
108 For further information see @ref occt_step_2_4 "Mapping STEP entities to Open CASCADE Technology shapes".
109
110 @subsubsection occt_step_2_2_4 Geometrical entities
111 The types of STEP geometrical entities that can be translated are: 
112   * points 
113   * vectors 
114   * directions 
115   * curves 
116   * surfaces 
117   
118 For further information see 2.4 Mapping STEP entities to Open CASCADE Technology shapes. 
119
120 @subsection occt_step_2_3 Description of the process
121 @subsubsection occt_step_2_3_1 Loading the STEP file
122
123 Before performing any other operation you have to load the file with: 
124 ~~~~~
125 STEPControl_Reader reader; 
126 IFSelect_ReturnStatus stat = reader.ReadFile(;filename.stp;); 
127 ~~~~~
128 Loading the file only memorizes the data, it does not translate it. 
129
130 @subsubsection occt_step_2_3_2 Checking the STEP file
131 This step is not obligatory. Check the loaded file with: 
132 ~~~~~
133 reader.PrintCheckLoad(failsonly,mode); 
134 ~~~~~
135 Error messages are displayed if there are invalid or incomplete STEP entities, giving you the information on the cause of error. 
136
137 If *failsonly* is true only fail messages are displayed. All messages are displayed if *failsonly* is false. Your analysis of the file can be either message-oriented or entity-oriented. Choose your preference with: 
138 ~~~~~
139 IFSelect_PrintCount mode = IFSelect_xxx 
140 ~~~~~
141 Where xxx can be one of the following: 
142 * *ItemsByEntity*  --       gives a sequential list of all messages per STEP entity, 
143 * *CountByItem*   --   gives the number of STEP entities with their types per message 
144 * *ListByItem*  -- gives the number of STEP entities with their types and rank numbers per message 
145
146 @subsubsection occt_step_2_3_3 Setting the translation parameters
147 The following parameters can be used to translate a STEP file into an OCCT shape. 
148
149 If you give a value that is not within the range of possible values it will simply be ignored. 
150
151 <h4>read.precision.mode</h4>
152 Defines which precision value will be used during translation (see section 2.5 below for details on precision and tolerances). 
153 * *File (0)* -- the precision value is set to length_measure in uncertainty_measure_with_unit from STEP file. 
154 * *User (1)* -- the precision value is that of the *read.precision.val* parameter. 
155
156 Read this parameter with: 
157
158 ~~~~~
159 Standard_Integer ic = Interface_Static::IVal("read.precision.mode");  
160 ~~~~~
161 Modify this parameter with: 
162 ~~~~~
163 if(!Interface_Static::SetIVal("read.precision.mode",1))  
164 .. error .. 
165 ~~~~~
166 Default value is File (0).
167  
168 <h4>read.precision.val:</h4>
169 User defined precision value. This parameter gives the precision for shape construction when the read.precision.mode parameter value is 1. By default it is 0.0001, but can be any real positive (non null) value. 
170
171 This value is a basic value of tolerance in the processor. The value is in millimeters, independently of the length unit defined in the STEP file. 
172
173 Read this parameter with: 
174 ~~~~~
175 Standard_Real rp = Interface_Static::RVal("read.precision.val"); 
176 ~~~~~
177 Modify this parameter with: 
178 ~~~~~
179 if(!Interface_Static::SetRVal("read.precision.val",0.01))  
180 .. error .. 
181 ~~~~~
182 By default this value is 0.0001. 
183
184 The value given to this parameter is a basic value for ShapeHealing algorithms and the processor. It does its best to reach it. Under certain circumstances, the value you give may not be attached to all of the entities concerned at the end of processing. STEP-to-OpenCASCADE translation does not improve the quality of the geometry in the original STEP file. This means that the value you enter may be impossible to attach to all shapes with the given quality of the geometry in the STEP file. 
185
186 <h4>read.maxprecision.val</h4>
187 Defines the maximum allowed tolerance (in mm) of the shape. It should be not less than the basic value of tolerance set in the processor (either the uncertainty from the file or *read.precision.val*). Actually, the maximum between *read.maxprecision.val* and the basis tolerance is used to define the maximum allowed tolerance. 
188
189 Read this parameter with: 
190 ~~~~~
191 Standard_Real rp = Interface_Static::RVal("read.maxprecision.val"); 
192 ~~~~~
193 Modify this parameter with: 
194 ~~~~~
195 if(!Interface_Static::SetRVal("read.maxprecision.val",0.1))  
196 .. error .. 
197 ~~~~~
198
199 Default value is 1. 
200 Note that maximum tolerance even explicitly defined by the user may be insufficient to ensure the validity of the shape (if real geometry is of bad quality). Therefore the user is provided with an additional parameter, which allows him to choose: either he prefers to ensure the shape validity or he rigidly sets the value of maximum tolerance. In the first case there is a possibility that the tolerance will not have any upper limit, in the second case the shape may be invalid. 
201
202 <h4>read.maxprecision.mode:</h4>
203 Defines the mode of applying the maximum allowed tolerance. Its possible values are: 
204 * 0 (Preferred) -- maximum tolerance is used as a limit but sometimes it can be exceeded (currently, only for deviation of a 3D curve and pcurves of an edge, and vertices of such edge) to ensure the shape validity, 
205 * 1 (Forced) --    maximum tolerance is used as a rigid limit, i.e. no tolerance can exceed it and if it is the case, the tolerance is trimmed by the maximum tolerance. 
206
207 Read this parameter with: 
208 ~~~~~
209 Standard_Integer ic = Interface_Static::IVal("read.maxprecision.mode"); 
210 ~~~~~
211 Modify this parameter with: 
212 ~~~~~
213 if(!Interface_Static::SetIVal("read.maxprecision.mode",1))  
214 .. error .. 
215 ~~~~~
216 Default value is 0 ("Preferred").
217  
218 <h4>read.stdsameparameter.mode</h4>
219 defines the use of *BRepLib::SameParameter*. Its possible values are: 
220
221 * 0 (Off) -- *BRepLib::SameParameter* is not called, 
222 * 1 (On) -- *BRepLib::SameParameter* is called. 
223 The functionality of *BRepLib::SameParameter* is used through *ShapeFix_Edge::SameParameter*. It ensures that the resulting edge will have the lowest tolerance taking pcurves either unmodified from the STEP file or modified by *BRepLib::SameParameter*.
224  
225 Read this parameter with: 
226 ~~~~~
227 Standard_Integer mv = Interface_Static::IVal("read.stdsameparameter.mode"); 
228 ~~~~~
229 Modify this parameter with: 
230 ~~~~~
231 if (!Interface_Static::SetIVal ("read.stdsameparameter.mode",1)) 
232 .. error ..; 
233 ~~~~~
234 Default value is 0 (;Off;). 
235
236 <h4>read.surfacecurve.mode:</h4>
237 a preference for the computation of curves in an entity which has both 2D and 3D representation. 
238 Each *TopoDS_Edge* in *TopoDS_Face* must have a 3D and 2D curve that references the surface. 
239
240 If both 2D and 3D representation of the entity are present, the computation of these curves depends on the following values of parameter: 
241 * *Default (0)* :                 no preference, both curves are taken (default value), 
242 * *3DUse_Preferred (3)* :  3D curves are used to rebuild 2D ones. 
243
244 Read this parameter with: 
245 ~~~~~
246 Standard_Integer rp = Interface_Static::IVal("read.surfacecurve.mode"); 
247 ~~~~~
248 Modify this parameter with: 
249 ~~~~~
250 if(!Interface_Static::SetIVal("read.surfacecurve.mode",3))  
251 .. error .. 
252 ~~~~~
253 Default value is (0). 
254
255 <h4>read.encoderegularity.angle</h4>
256
257 This parameter is used for call to *BRepLib::EncodeRegularity()* function which is called for the shape read from an IGES or a STEP file at the end of translation process. This function sets the regularity flag of the edge in the shell when this edge is shared by two faces. This flag shows the continuity these two faces are connected with at that edge.  
258 Read this parameter with: 
259 ~~~~~
260 Standard_Real era =  Interface_Static::RVal("read.encoderegularity.angle"); 
261 ~~~~~
262 Modify this parameter with: 
263 ~~~~~
264 if (!Interface_Static::SetRVal ("read.encoderegularity.angle",0.1))  
265 .. error ..; 
266 ~~~~~
267 Default value is 0.01. 
268
269 <h4>step.angleunit.mode</h4>
270 This parameter is obsolete (it was required in the past for STEP files with a badly encoded angle unit). It indicates what angle units should be used when a STEP file is read: the units from file (default), or forced RADIANS or DEGREES. 
271
272 Default value is File 
273
274 <h4>read.step.resource.name and read.step.sequence</h4>
275
276 These two parameters define the name of the resource file and the name of the sequence of operators (defined in that file) for Shape Processing, which is automatically performed by the STEP translator. Shape Processing is a user-configurable step, which is performed after translation and consists in applying a set of operators to a resulting shape. This is a very powerful tool allowing customizing the shape and adapting it to the needs of a receiving application. By default the sequence consists of a single operator ShapeFix -- that is how Shape Healing is called from the STEP translator. 
277
278 Please find an example of the resource file for STEP (which defines parameters corresponding to the sequence applied by default, i.e. if the resource file is not found) in the Open CASCADE Technology installation, by the path <i>%CASROOT%/src/XSTEPResource/STEP</i>.
279  
280 In order for the STEP translator to use that file, you have to define the *CSF_STEPDefaults* environment variable, which should point to the directory where the resource file resides. Note that if you change parameter *read.step.resource.name*, you will change the name of the resource file and the environment variable correspondingly. 
281
282 Default values:  
283 * read.step.resource.name -- STEP, 
284 * read.step.sequence -- FromSTEP. 
285
286 <h4>xstep.cascade.unit</h4>
287 This parameter defines units to which a shape should be converted when translated from IGES or STEP to CASCADE. Normally it is MM; only those applications that work internally in units other than MM should use this parameter. 
288
289 Default value is MM. 
290
291 <h4>read.step.product.mode:</h4>
292 Defines the approach used for selection of top-level STEP entities for translation, and for recognition of assembly structures 
293 * 1 (ON) -- *PRODUCT_DEFINITION* entities are taken as top-level ones; assembly structure is recognized by *NEXT_ASSEMBLY_USAGE_OCCURRENCE* entities. This is regular mode for reading valid STEP files conforming to AP 214, AP203 or AP 209. 
294 * 0 (OFF) -- *SHAPE_DEFINITION_REPRESENTATION* entities are taken as top-level ones; assembly is recognized by *CONTEXT_DEPENDENT_SHAPE_REPRESENTATION* entities. This is compatibility mode, which can be used for reading legacy STEP files produced by older versions of STEP translators and having incorrect or incomplete product information. 
295
296 Read this parameter with: 
297 ~~~~~
298 Standard_Integer ic = Interface_Static::IVal("read.step.product.mode");  
299 ~~~~~
300
301 Modify this parameter with: 
302 ~~~~~
303 if(!Interface_Static::SetIVal("read.step.product.mode",1))  
304 .. error .. 
305 ~~~~~
306 Default value is 1 (ON).
307  
308 Note that the following parameters have effect only if *read.step.product.mode* is ON. 
309
310 <h4>read.step.product.context:</h4>
311
312 When reading AP 209 STEP files, allows selecting either only ‘design’ or ‘analysis’, or both types of products for translation 
313 * 1 (all) --  translates all products;
314 * 2 (design) -- translates only products that have *PRODUCT_DEFINITION_CONTEXT* with field *life_cycle_stage* set to ‘design’; 
315 * 3 (analysis) --   translates only products associated with *PRODUCT_DEFINITION_CONTEXT* entity whose field *life_cycle_stage* set to ‘analysis’. 
316
317 Note that in AP 203 and AP214 files all products should be marked as ‘design’, so if this mode is set to ‘analysis’, nothing will be read. 
318
319 Read this parameter with: 
320 ~~~~~
321 Standard_Integer ic =  Interface_Static::IVal("read.step.product.context");
322 ~~~~~
323   
324 Modify this parameter with: 
325 ~~~~~
326 if(!Interface_Static::SetIVal(;read.step.product.context;,1))  
327 .. error .. 
328 ~~~~~
329 Default value is 1 (all).
330  
331 <h4>read.step.shape.repr:</h4>
332
333 Specifies preferred type of representation of the shape of the product, in case if a STEP file contains more than one representation (i.e. multiple PRODUCT_DEFINITION_SHAPE entities) for a single product 
334 * 1 (All) --          Translate all representations (if more than one, put in compound). 
335 * 2 (ABSR) -      Prefer ADVANCED_BREP_SHAPE_REPRESENTATION 
336 * 3 (MSSR)  --    Prefer MANIFOLD_SURFACE_SHAPE_REPRESENTATION 
337 * 4 (GBSSR) --   Prefer GEOMETRICALLY_BOUNDED_SURFACE_SHAPE_REPRESENTATION 
338 * 5 (FBSR) --      Prefer FACETTED_BREP_SHAPE_REPRESENTATION 
339 * 6 (EBWSR) --   Prefer EDGE_BASED_WIREFRAME_SHAPE_REPRESENTATION 
340 * 7 (GBWSR) --   Prefer GEOMETRICALLY_BOUNDED_WIREFRAME _SHAPE_REPRESENTATION  
341
342 When this option is not equal to 1, for products with multiple representations the representation having a type closest to the selected one in this list will be translated. 
343
344 Read this parameter with: 
345 ~~~~~
346 Standard_Integer ic = Interface_Static::IVal("read.step.shape.repr");  
347 ~~~~~
348 Modify this parameter with: 
349 ~~~~~
350 if(!Interface_Static::SetIVal("read.step.shape.repr",1))  
351 .. error .. 
352 ~~~~~
353 Default value is 1 (All). 
354
355 <h4>read.step.assembly.level:</h4>
356
357 Specifies which data should be read for the products found in the STEP file: 
358 * 1 (All) --         Translate both the assembly structure and all associated shapes. If both shape and sub-assemblies are associated with the same product, all of them are read and put in a single compound. Note that this situation is confusing, as semantics of such configuration is not defined clearly by the STEP standard (whether this shape is an alternative representation of the assembly or is an addition to it), therefore warning will be issued in such case. 
359 * 2 (assembly) -- Translate the assembly structure and shapes associated with parts only (not with sub-assemblies). 
360 * 3 (structure) --  Translate only the assembly structure without shapes (a structure of empty compounds). This mode can be useful as an intermediate step in applications requiring specialized processing of assembly parts. 
361 * 4 (shape) --      Translate only shapes associated with the product, ignoring the assembly structure (if any). This can be useful to translate only a shape associated with specific product, as a complement to *assembly* mode. 
362
363 Read this parameter with: 
364 ~~~~~
365 Standard_Integer ic =                   Interface_Static::IVal("read.step.assembly.level"); 
366 ~~~~~
367 Modify this parameter with: 
368 ~~~~~
369 if(!Interface_Static::SetIVal("read.step.assembly.level",1))  
370 .. error .. 
371 ~~~~~
372
373 Default value is 1 (All). 
374
375 <h4>read.step.shape.relationship:</h4>
376 Defines whether shapes associated with the main *SHAPE_DEFINITION_REPRESENTATION* entity of the product via *SHAPE_REPRESENTATIONSHIP_RELATION* should be translated. This kind of association is used for the representation of hybrid models (i.e. models whose shape is composed of different types of representations) in AP 203 files since 1998, but it can be also used to associate auxiliary data with the product. This parameter allows to avoid translation of such auxiliary data. 
377 * 1 (ON) --          translate 
378 * 0 (OFF) --        do not translate 
379
380 Read this parameter with: 
381 ~~~~~
382 Standard_Integer ic =           Interface_Static::IVal("read.step.shape.relationship");
383 ~~~~~ 
384 Modify this parameter with: 
385 ~~~~~
386 if(!Interface_Static::SetIVal(;read.step.shape.relationship;,1))  
387 .. error .. 
388 ~~~~~
389 Default value is 1 (ON).
390  
391 <h4>read.step.shape.aspect:</h4>
392 Defines whether shapes associated with the *PRODUCT_DEFINITION_SHAPE* entity of the product via *SHAPE_ASPECT* should be translated. This kind of association was used for the representation of hybrid models (i.e. models whose shape is composed of different types of representations) in AP 203 files before 1998, but it is also used to associate auxiliary information with the sub-shapes of the part. Though STEP translator tries to recognize such cases correctly, this parameter may be useful to avoid unconditionally translation of shapes associated via *SHAPE_ASPECT* entities. 
393
394 * 1 (ON) --          translate 
395 * 0 (OFF) --        do not translate 
396
397 Read this parameter with: 
398 ~~~~~
399 Standard_Integer ic =                   Interface_Static::IVal("read.step.shape.aspect"); 
400 ~~~~~
401
402 Modify this parameter with: 
403 ~~~~~
404 if(!Interface_Static::SetIVal(;read.step.shape.aspect;,1))  
405 .. error .. 
406 ~~~~~
407 Default value is 1 (ON). 
408
409 @subsubsection occt_step_2_3_4 Performing the STEP file translation
410
411 Perform the translation according to what you want to translate. You can choose either root entities (all or selected by the number of root), or select any entity by its number in the STEP file. There is a limited set of types of entities that can be used as starting entities for translation. Only the following entities are recognized as transferable: 
412   * product_definition
413   * next_assembly_usage_occurrence
414   * shape_definition_representation
415   * subtypes of shape_representation (only if referred representation is transferable)
416   * manifold_solid_brep
417   * brep_with_voids
418   * faceted_brep
419   * faceted_brep_and_brep_with_voids
420   * shell_based_surface_model
421   * geometric_set and geometric_curve_set
422   * mapped_item 
423   * subtypes of face_surface (including advanced_face)
424   * subtypes of shape_representation_relationship
425   * context_dependent_shape_representation
426   
427 The following methods are used for translation:
428
429 * *Standard_Boolean ok = reader.TransferRoot(rank)* -- translates a root entity identified by its rank;
430 * *Standard_Boolean ok = reader.TransferOne(rank)* -- translates an entity identified by its rank;
431 * *Standard_Integer num = reader.TransferList(list)* -- translates a list of entities in one operation (this method returns the number of successful translations);
432 * *Standard_Integer NbRoots = reader.NbRootsForTransfer()* and *Standard_Integer num = reader.TransferRoots()* -- translate all transferable roots. 
433
434 @subsubsection occt_step_2_3_5 Getting the translation results
435 Each successful translation operation outputs one shape. A series of translations gives a set of shapes. 
436
437 Each time you invoke *TransferOne(), TransferRoot()* or *TransferList()*, their results are accumulated and the counter of results increases. You can clear the results with: 
438 ~~~~~
439 reader.ClearShapes(); 
440 ~~~~~
441 between two translation operations, if you do not, the results from the next translation will be added to the accumulation. 
442
443 *TransferRoots()* operations automatically clear all existing results before they start. 
444 * *Standard_Integer num = reader.NbShapes()* -- gets the number of shapes recorded in the result; 
445 * *TopoDS_Shape shape = reader.Shape(rank)* -- gets the result identified by its rank, where rank is an integer between 1 and NbShapes;
446 * *TopoDS_Shape shape = reader.Shape()* -- gets the first result of translation; 
447 * *TopoDS_Shape shape = reader.OneShape()* -- gets all results in a single shape, which is:
448   * a null shape if there are no results, 
449   * in case of a single result, a shape that is specific to that result, 
450   * a compound that lists the results if there are several results. 
451
452 <h5>Clearing the accumulation of results</h5>
453
454 If several individual translations follow each other, the results give a list that can be purged with *reader.ClearShapes()*, which erases the existing results. 
455
456 <h5>Checking that translation was correctly performed</h5>
457 Each time you invoke *Transfer* or *TransferRoots()*,  you can display the related messages with the help of: 
458 ~~~~~
459 reader.PrintCheckTransfer(failsonly,mode); 
460 ~~~~~
461
462 This check concerns the last invocation of *Transfer* or *TransferRoots()* only. 
463
464 @subsubsection occt_step_2_3_6 Selecting STEP entities for translation
465
466 <h4>Selection possibilities</h4>
467
468 There are three selection possibilities. You can select: 
469   * the whole file,
470   * a list of entities,
471   * one entity.
472   
473 <h5>The whole file</h5>
474
475 Transferring the whole file means transferring all root entities. The number of roots can be evaluated when the file is loaded: 
476 ~~~~~
477 Standard_Integer NbRoots = reader.NbRootsForTransfer(); 
478 Standard_Integer num = reader.TransferRoots(); 
479 ~~~~~
480
481 <h5>List of entities</h5>
482 A list of entities can be formed by invoking *STEP214Control_Reader::GiveList* (this is a method of the parent class). 
483
484 Here is a simple example of how a list is translated: 
485 ~~~~~
486 Handle(TColStd_HSequenceOfTransient) list = reader.GiveList(); 
487 ~~~~~
488 The result is a *TColStd_HSequenceOfTransient*. 
489 You can either translate a list entity by entity or all at once. An entity-by-entity operation lets you check each individual entity translated. 
490
491 <h5>Translating a whole list in one operation</h5>
492 ~~~~~
493 Standard_Integer nbtrans = reader.TransferList (list); 
494 ~~~~~
495 *nbtrans* gives the number of items in the list that produced a shape. 
496
497 <h5>Translating a list entity by entity:</h5>
498 ~~~~~
499 Standard_Integer i,nb = list->Length();
500 for (i = 1; i <= nb; i ++) {
501  Handle(Standard_Transient) ent = list->Value(i);
502  Standard_Boolean OK = reader.TransferEntity (ent);
503 }
504 ~~~~~
505
506 <h4>Selections</h4>
507 There is a number of predefined operators that can be used. They are: 
508   * *step214-placed-items* -- selects all mapped_items or context_depended_shape_representations. 
509   * *step214-shape-def-repr* -- selects all shape_definition_representations. 
510   * *step214-shape-repr* -- selects all shape_representations. 
511   * *step214-type(\<entity_type\>)* -- selects all entities of a given type 
512   * *step214-faces* -- selects all faces_surface, advanced_face entities and the surface entity or any sub type if these entities are not shared by any face entity or shared by geometric_set entity. 
513   * *step214-derived(\<entity_type\>)* -- selects entities of a given type or any subtype. 
514   * *step214-GS-curves* -- selects all curve entities or any subtype except the composite_curve if these entities are shared by the geometric_set entity. 
515   * *step214-assembly* -- selects all mapped_items or context_depended_shape_representations involved into the assembly structure. 
516   * *xst-model-all* -- selects all entities. 
517   * *xst-model-roots* -- selects all roots. 
518   * *xst-shared + \<selection\>* -- selects all entities shared by at least one entity selected by selection. 
519   * *xst-sharing + \<selection\>* -- selects all entities sharing at least one entity selected by selection. 
520   * *xst-transferrable-all* -- selects all transferable entities. 
521   * *xst-transferrable-roots* -- selects all translatable roots. 
522 Cumulative lists can be used as well.
523  
524 <h5>Single entities</h5>
525 You can select an entity either by its rank or by its handle (an entity’s handle can be obtained by invoking the *StepData_StepModel::Entity* function). 
526
527 <h5>Selection by rank</h5>
528 Use method *StepData_StepModel::NextNumberForLabel* to find its rank with the following: 
529 ~~~~~
530 Standard_CString label = ‘#...’; 
531 StepData_StepModel model = reader.StepModel(); 
532 rank = model->NextNumberForLabe(label, 0, Standard_False); 
533 ~~~~~
534 Translate an entity specified by its rank: 
535 ~~~~~
536 Standard_Boolean ok = reader.Transfer (rank); 
537 ~~~~~
538
539 <h5>Direct selection of an entity</h5>
540 *ent* is the entity. The argument is a *Handle(Standard_Transient)*. 
541 ~~~~~
542 Standard_Boolean ok = reader.TransferEntity (ent); 
543 ~~~~~
544
545 @subsection occt_step_2_4 Mapping STEP entities to Open CASCADE Technology shapes
546 Tables given in this paragraph show the mapping of STEP entities to OCCT objects. Only topological and geometrical STEP entities and entities defining assembly structures are described in this paragraph. For a full list of STEP entities please refer to Appendix A. 
547
548 @subsubsection occt_step_2_4_1 Assembly structure representation entities
549 Not all entities defining the assembly structure in the STEP file are translated to OCCT shapes, but they are used to identify the relationships between assemblies and their components. Since the graph of ‘natural’ dependencies of entities based on direct references between them does not include the references from assemblies to their components, these dependencies are introduced in addition to the former ones. This is made basing on the analysis of the following entities describing the structure of the assembly. 
550
551 | STEP entity type | CASCADE shape | Comments |
552 | :--------------- | :-------------- | :------ |
553 | product_definition |  A *TopoDS_Compound* for assemblies, a CASCADE shape corresponding to the component type of  for components, | Each assembly or component has its own *product_definition*. It is used as a starting point for translation when *read.step.product.mode* is ON. |
554 | product_definition_shape | | This entity provides a link between *product_definition* and corresponding *shape_definition_representation*,  or between *next_assembly_usage_occurence* and corresponding *context_dependent_shape_representation*. | 
555 | shape_definition_representation | A TopoDS_Compound for assemblies, a CASCADE shape corresponding to the component type for components. | Each assembly or component has its own *shape_definition_representation*. The graph of dependencies is modified in such a way that *shape_definition_representations* of all components of the assembly are referred by the *shape_definition_representation* of the assembly.  |
556 | next_assembly_usage_occurence | | This entity defines a relationship between the assembly and its component. It is used to introduce (in the dependencies graph) the links between *shape_definition_representation* of the assembly and *shape_definition_representations* and *context_dependent_shape_representations* of all its components. |
557 | mapped_item | TopoDS_Shape | This entity defines a mapping of the assembly component into the *shape_representation* of the assembly. The result of translation is a CASCADE shape translated from the component, to which transformation defined by the *mapped_item* is applied. |
558 | context_dependent_shape_representation | TopoDS_Shape | This entity is associated with the *next_assembly_usage_occurence* entity and defines a placement of the component in the assembly. The graph of dependencies is modified so that each *context_dependent_shape_representation* is referred by shape_definition_representation of the corresponding assembly. |
559 | shape_representation_relationship_with_transformation | | This entity is associated with *context_dependent_shape_representation* and defines a transformation necessary to apply to the component in order to locate it in its place in the assembly. |
560 | item_defined_transformation | | This entity defines a transformation operator used by *shape_representation_relationship_with_transformation* or *mapped_item* entity |
561 | cartesian_transformation_operator | | This entity defines a transformation operator used by *shape_representation_relationship_with_transformation* or *mapped_item* entity |
562
563 @subsubsection occt_step_2_4_2 Models
564 | STEP entity type | CASCADE shape | Comments |
565 | :-------------- | :----------- | :---------- |
566 | Solid Models | | | 
567 | brep_with_voids | TopoDS_Solid | |
568 | faceted_brep | TopoDS_Solid | |
569 | manifold_solid_brep | TopoDS_Solid | |
570 | Surface Models | | | 
571 | shell_based_surface_model  | TopoDS_Compound | *shell_based_surface_model* is translated into one or more *TopoDS_Shell* grouped in a *TopoDS_Compound* |
572 | geometric_set | TopoDS_Compound | *TopoDS_Compound* contains only *TopoDS_Faces*, *TopoDS_Wires*, *TopoDS_Edges* and/or *TopoDS_Vertices*.
573 | Wireframe Models | | | 
574 | geometric_curve_set | TopoDS_Compound | *TopoDS_Compound* contains only *TopoDS_Wires*, *TopoDS_Edges* and/or *TopoDS_Vertices*.
575
576 @subsubsection occt_step_2_4_3 Topological entities
577
578 | Topology | STEP entity type | CASCADE shape | Comments |
579 | :------- | :--------- | :-------- | :----- |
580 | Vertices | vertex_point | TopoDS_Vertex | |
581 | Edges | oriented_edge | TopoDS_Edge | |
582 | | edge_curve | TopoDS_Edge | |
583 | Loops | face_bound | TopoDS_Wire | |
584 | | face_outer_bound | TopoDS_Wire | | 
585 | | edge_loop | TopoDS_Wire | |
586 | | poly_loop | TopoDS_Wire | Each segment of *poly_loop* is translated into *TopoDS_Edge* with support of *Geom_Line* |
587 | | vertex_loop | TopoDS_Wire | Resulting *TopoDS_Wire* contains only one degenerated *TopoDS_Edge* |
588 | Faces | face_surface | TopoDS_Face | |
589 | | advanced_face | TopoDS_Face | |
590 | Shells | connected_face_set | TopoDS_Shell | |
591 | | oriented_closed_shell | TopoDS_Shell | |
592 | | closed_shell | TopoDS_Shell | |
593 | | open_shell | TopoDS_Shell | |
594
595 @subsubsection occt_step_2_4_4 Geometrical entities
596 3D STEP entities are translated into geometrical objects from the *Geom* package while 2D entities are translated into objects from the *Geom2d* package. 
597 | Geometry | STEP entity type | CASCADE object | Comments |
598 | :------ | :-------- | :------ | :-------- |
599 | Points | cartesian_point | Geom_CartesianPoint, Geom2d_CartesianPoint | |
600 | Directions | direction | Geom_Direction, Geom2d_Direction | |
601 | Vectors | vector | Geom_VectorWithMagnitude, Geom2d_VectorWithMagnitude | | 
602 | Placements | axis1_placement | Geom_Axis1Placement | |  
603 | | axis2_placement_2d | Geom2d_AxisPlacement | |
604 | | axis2_placement_3d | Geom_Axis2Placement | | 
605 | Curves | circle | Geom_Circle, Geom2d_Circle, Geom2d_BsplineCurve | Circle is translated into *Geom2d_BSplineCurve* when it references the surface of revolution (spherical surface, conical surface, etc.) |
606 | | ellipse | Geom_Ellipse, Geom2d_Ellipse, Geom2d_BsplineCurve | Ellipse is translated into *Geom2d_BSplineCurve* when it references the surface of revolution (spherical surface, conical surface, etc.) |
607 | | hyperbola | Geom_Hyperbola, Geom2d_Hyperbola | | 
608 | | line | Geom_Line, Geom2d_Line | | 
609 | | parabola | Geom_Parabola, Geom2d_Parabola | |  
610 | | pcurve  | Geom2d_Curve | Pcurve in edge | 
611 | | curve_replica | Geom_Curve or Geom2d_Curve | Depending on the type of the base curve |
612 | | offset_curve_3d | Geom_OffsetCurve | | 
613 | | trimmed_curve | Geom_TrimmedCurve or Geom2d_BsplineCurve | Only trimmed_curves trimmed by parameters are translated. All *trimmed_curves* are converted to *Geom2d_BSplineCurve*. |
614 | | b_spline_curve | Geom_BsplineCurve or Geom2d_BsplineCurve | |  
615 | | b_spline_curve_with_knots | Geom_BsplineCurve or Geom2d_BsplineCurve | |
616 | | bezier_curve | Geom_BsplineCurve or Geom2d_BsplineCurve | | 
617 | | rational_b_spline_curve | Geom_BsplineCurve or  Geom2d_BsplineCurve | | 
618 | | uniform_curve | Geom_BsplineCurve or Geom2d_BsplineCurve | | 
619 | | quasi_ uniform_curve | Geom_BsplineCurve or Geom2d_BsplineCurve | |
620 | | surface_curve | TopoDS_Edge | *surface_curve* defines geometrical support of an edge and its pcurves. |
621 | | seam_curve | TopoDS_Edge | The same as *surface_curve*  |
622 | | composite_curve_segment | TopoDS_Edge | as a segment of *composite_curve* |
623 | | composite_curve | TopoDS_Wire | |  
624 | | composite_curve_on_surface | TopoDS_Wire | | 
625 | | boundary_curve |  TopoDS_Wire | | 
626 | Surfaces | b_spline_surface | Geom_BsplineSurface | |
627 | |  b_spline_surface_with_knots | Geom_BsplineSurface | | 
628 | | bezier_surface | Geom_BSplineSurface | | 
629 | | conical_surface | Geom_ConicalSurface | | 
630 | | cylindrical_surface | Geom_CylindricalSurface  | |
631 | | offset_surface | Geom_OffsetSurface | |
632 | | surface_replica | Geom_Surface | Depending on the type of basis surface |
633 | | plane | Geom_Plane | |
634 | | rational_b_spline_surface | Geom_BSplineSurface | |
635 | | rectangular_trimmed_surface | Geom_RectangularTrimmedSurface | | 
636 | | spherical_surface | Geom_SphericalSurface | |
637 | | surface_of_linear_extrusion | Geom_SurfaceOfLinearExtrusion  | |
638 | | surface_of_revolution | Geom_SurfaceOfRevolution | |
639 | | toroidal_surface | Geom_ToroidalSurface | | 
640 | | degenerate_toroidal_surface | Geom_ToroidalSurface | |
641 | | uniform_surface | Geom_BSplineSurface | |
642 | | quasi_uniform_surface | Geom_BSplineSurface | | 
643 | | rectangular_composite_surface | TopoDS_Compound | Contains *TopoDS_Faces* |
644 | | curve_bounded_surface | TopoDS_Face | |
645
646
647 @subsection occt_step_2_5 Tolerance management
648 @subsubsection occt_step_2_5_1 Values used for tolerances during reading STEP 
649
650 During the STEP to OCCT translation several parameters are used as tolerances and precisions for different algorithms. Some of them are computed from other tolerances using specific functions. 
651
652 <h4>3D (spatial) tolerance</h4>
653 * Package method *Precision::Confusion()* Value is 10-7. It is used as the minimal distance between points, which are considered to be distinct. 
654 * Uncertainty parameter is attached to each shape_representation entity in a STEP file and defined as *length_measure* in *uncertainty_measure_with_unit*. It is used as a fundamental value of precision during translation. 
655 * User-defined variable *read.precision.val* is used instead of uncertainty from a STEP file when parameter *read.precision.mode* is 1 (User).
656  
657 <h4>2D (parametric) tolerances</h4>
658 * Package method *Precision\::PConfusion()* is a value of *0.01\*Precision\::Confusion()*. It is used to compare parametric bounds of curves. 
659 * Methods *UResolution* and *VResolution (tolerance3d)* of the class *GeomAdaptor_Surface* or *BRepAdaptor_Surface* return tolerance in parametric space of a surface computed from 3d tolerance. When one tolerance value is to be used for both U and V parametric directions, the maximum or the minimum value of *UResolution* and *VResolution* is used. 
660 * Methods *Resolution (tolerance3d)* of the class *GeomAdaptor_Curve* or *BRepAdaptor_Curve* return tolerance in parametric space of a curve computed from 3d tolerance. 
661
662 @subsubsection occt_step_2_5_2 Initial setting of tolerances in translating objects
663 In the STEP processor, the basic value of tolerance is set in method *STEPControl_ActorRead::Transfer()* to either value of uncertainty in shape_representation in STEP file (if parameter *read.precision.mode* is 0), or to a value of parameter *read.precision.val* (if *read.precision.mode* is 1 or if the uncertainty is not attached to the current entity in the STEP file). 
664
665 Translation starts from one entity translated as a root. *STEPControl_ActorRead::Transfer()*, function which performs the translation  creates an object of the type *StepToTopoDS_Builder*, which is intended to translate topology. 
666
667 This object gets the initial tolerance value that is equal to *read.precision.val* or the uncertainty from shape_representation. During the translation of the entity, new objects of types *StepToTopoDS_Translate*... are created for translating sub-entities. All of them use the same tolerances as a *StepToTopoDS_Builder* object.
668  
669 @subsubsection occt_step_2_5_3 Transfer process
670
671 <h4>Evolution of shape tolerances during transfer</h4>
672 Let us follow the evolution of tolerances during the translation of STEP entities into an OCCT shape. 
673
674 If the starting STEP entity is a geometric_curve_set all the edges and vertices are constructed with *Precision::Confusion()*.
675  
676 If the starting STEP entity is not a geometric_curve_set the sub-shapes of the resulting shape have the following tolerance: 
677   * all the faces are constructed with *Precision::Confusion()*, 
678   * edges are constructed with *Precision::Confusion()*. It can be modified later by: 
679   * *ShapeFix::SameParameter()* -- the tolerance of edge shows real deviation of the 3D curve and pcurves. 
680   * *ShapeFix_Wire::FixSelfIntersection()* if a pcurve of a self-intersecting edge is modified. 
681   * vertices are constructed with Precision::Confusion(). It can be modified later by: 
682   *StepToTopoDS_TranslateEdge* 
683   *ShapeFix::SameParameter()* 
684   *ShapeFix_Wire::FixSelfIntersection()*  
685   *ShapeFix_Wire::FixLacking()* 
686   *ShapeFix_Wire::Connected()*
687   
688 So, the final tolerance of sub-shapes shows the real local geometry of shapes (distance between vertices of adjacent edges, deviation of a 3D curve of an edge and its parametric curves and so on) and may be less or greater than the basic value of tolerance in the STEP processor. 
689
690 <h4>Translating into Geometry</h4>
691
692 Geometrical entities are translated by classes *StepToGeom_Make...* Methods of these classes translate STEP geometrical entities into OCCT geometrical objects. Since these objects are not BRep objects, they do not have tolerances. Tolerance is used only as precision for detecting bad cases (such as points coincidence). 
693
694 <h4>Translating into Topology</h4>
695 STEP topological entities are translated into OCCT shapes by use of classes from package *StepToTopoDS*.
696
697 Although in a STEP file the uncertainty value is assigned to shape_representation entities and this value is applied to all entities in this shape_representation, OCCT shapes are produced with different tolerances. As a rule, updating the tolerance is fulfilled according to the local geometry of shapes (distance between vertices of adjacent edges, deviation of edge's 3D curve and its parametric curves and so on) and may be either less or greater than the uncertainty value assigned to the entity. 
698
699 The following default tolerances are used when creating shapes and how they are updated during translation. 
700 * *StepToTopoDS_TranslateVertex* constructs *TopoDS_Vertex* from a STEP *vertex_point* entity with *Precision::Confusion()*. 
701 * *StepToTopoDS_TranslateVertexLoop* creates degenerated *TopoDS_Edge* in *TopoDS_Wire* with tolerance *Precision::Confusion()*. *TopoDS_Vertex* of a degenerated edge is constructed with the initial value of tolerance. 
702 * *StepToTopoDS_TranslateEdge* constructs *TopoDS_Edge* only on the basis of 3D curve with *Precision::Confusion()*. Tolerance of the vertices can be increased up to a distance between their positions and ends of 3D curve. 
703 * *StepToTopoDS_TranslateEdgeLoop* constructs *TopoDS_Edges* in *TopoDS_Wire* with help of class *StepToTopoDS_TranslateEdge*. Pcurves from a STEP file are translated if they are present and *read.surfacecurve.mode* is 0. For each edge method *ShapeFix_Edge::FixSameParameter()* is called. If the resulting tolerance of the edge is greater than the maximum value between 1.0 and 2*Value of basis precision, then the pcurve is recomputed. The best of the original and the recomputed pcurve is put into *TopoDS_Edge*. The resulting tolerance of *TopoDS_Edge* is a maximal deviation of its 3D curve and its pcurve(s). 
704 * *StepToTopoDS_TranslatePolyLoop* constructs *TopoDS_Edges* in *TopoDS_Wire* with help of class *StepToTopoDS_TranslateEdge*. Their tolerances are not modified inside this method. 
705 * *StepToTopoDS_TranslateFace* constructs *TopoDS_Face* with the initial value of tolerance. *TopoDS_Wire* on *TopoDS_Face* is constructed with the help of classes *StepToTopoDS_TranslatePolyLoop, StepToTopoDS_TranslateEdgeLoop* or *StepToTopoDS_TranslateVertexLoop*.  
706 * *StepToTopoDS_TranslateShell* calls *StepToTopoDS_TranslateFace::Init* for each face. This class does not modify the tolerance value. 
707 * *StepToTopoDS_TranslateCompositeCurve* constructs *TopoDS_Edges* in *TopoDS_Wire* with help of class *BRepAPI_MakeEdge* and have a tolerance 10-7. Pcurves from a STEP file are translated if they are present and if *read.surfacecurve.mode* is not -3. The connection between segments of a composite curve (edges in the wire) is provided by calling method *ShapeFix_Wire::FixConnected()\** with a precision equal to the initial value of tolerance.
708 * *StepToTopoDS_TranslateCurveBoundedSurface* constructs *TopoDS_Face* with tolerance *Precision::Confusion()*. *TopoDS_Wire* on *TopoDS_Face* is constructed with the help of class *StepToTopoDS_TranslateCompositeCurve*. Missing pcurves are computed using projection algorithm with the help of method *ShapeFix_Face::FixPcurves()*. For resulting face method *ShapeFix::SameParameter()* is called. It calls standard *BRepLib::SameParameter* for each edge in each wire, which can either increase or decrease the tolerances of the edges and vertices. *SameParameter* writes the tolerance corresponding to the real deviation of pcurves from 3D curve which can be less or greater than the tolerance in a STEP file. 
709 * *StepToTopoDS_Builder* a high level class. Its methods perform translation with the help of the classes listed above. If the value of *read.maxprecision.mode* is set to 1 then the tolerance of subshapes of the resulting shape is limited by 0 and *read.maxprecision.val*. Else this class does not change the tolerance value. 
710 * *StepToTopoDS_MakeTransformed* performs a translation of mapped_item entity and indirectly uses class *StepToTopoDS_Builder*. The tolerance of the resulting shape is not modified inside this method. 
711
712 <h4>Healing of resulting shape in ShapeHealing component</h4>
713 ##### ShapeFix_Wire::FixSelfIntersection() 
714 This method is intended for detecting and fixing self-intersecting edges and intersections of adjacent edges in a wire. It fixes self-intersections by cutting edges at the intersection point and/or by increasing the tolerance of the vertex (so that the vertex comprises the point of intersection). There is a maximum tolerance that can be set by this method transmitted as a parameter, currently is *read.maxprecision.value*.
715
716 When a self-intersection of one edge is found, it is fixed by one of the two methods: 
717   * tolerance of the vertex of that edge which is nearest to the point of self-intersection is increased so that it comprises both its own old position and the intersection point
718   * the self-intersecting loop on the pcurve is cut out and a new pcurve is constructed. This can increase the tolerance of the edge. 
719   
720 The method producing a smaller tolerance is selected. 
721
722 When an intersection of two adjacent edges is detected, edges are cut at that point. Tolerance of the common vertex of these edges is increased in order to comprise both the intersection point and the old position. 
723
724 This method can increase the tolerance of the vertex up to a value of *read.maxprecision.value*. 
725
726 ##### ShapeFix_Wire::FixLacking() 
727 This method is intended to detect gaps between pcurves of adjacent edges (with the precision of surface UVResolution computed from tolerance of a corresponding vertex) and to fix these gaps either by increasing the tolerance of the vertex, or by inserting a new degenerated edge (straight in parametric space). 
728
729 If it is possible to compensate a gap by increasing the tolerance of the vertex to a value of less than the initial value of tolerance, the tolerance of the vertex is increased. Else, if the vertex is placed in a degenerated point then a degenerated edge is inserted. 
730
731 ##### ShapeFix_Wire::FixConnected() 
732 This method is intended to force two adjacent edges in the wire to share the same vertex. This method can increase the tolerance of the vertex. The maximal value of tolerance is *read.maxprecision.value*. 
733
734 @subsection occt_step_2_6 Code architecture
735
736 The following diagram illustrates the structure of calls in reading STEP. The highlighted classes are intended to translate geometry
737
738 @image html /user_guides/step/images/step_image003.png "The structure of calls in reading STEP"
739 @image latex /user_guides/step/images/step_image003.png "The structure of calls in reading STEP"
740   
741 @subsection occt_step_2_7 Example
742 ~~~~~
743 #include <STEPControl_Reader.hxx> 
744 #include <TopoDS_Shape.hxx> 
745 #include <BRepTools.hxx> 
746
747 Standard_Integer main() 
748
749   STEPControl_Reader reader; 
750   reader.ReadFile(;MyFile.stp;); 
751
752   // Loads file MyFile.stp 
753   Standard_Integer NbRoots = reader.NbRootsForTransfer(); 
754
755   // gets the number of transferable roots 
756   cout;Number of roots in STEP file: ; NbRootsendl; 
757
758   Standard_Integer NbTrans = reader.TransferRoots(); 
759   // translates all transferable roots, and returns the number of    //successful translations 
760   cout;STEP roots transferred: ; NbTransendl; 
761   cout;Number of resulting shapes is: ;reader.NbShapes()endl; 
762
763   TopoDS_Shape result = reader.OneShape(); 
764   // obtain the results of translation in one OCCT shape 
765
766   . . . 
767
768
769 ~~~~~
770
771
772 @section occt_step_3 Writing STEP
773 @subsection occt_step_3_1 Procedure
774 You can translate OCCT shapes into STEP entities in the following steps: 
775    1.initialize the process, 
776    2.set the translation parameters, 
777    3.perform the shape translation, 
778    4.write the output file. 
779    
780 You can translate several shapes before writing a file. All these translations output a separate shape_representation entity in STEP file. 
781
782 The user-defined option (parameter *write.step.schema*) is provided to define which version of schema (AP214 CD or DIS, or AP203) is used for the output STEP file. 
783
784 @subsection occt_step_3_2 Domain covered
785 @subsubsection occt_step_3_2_1 Writing geometry and topology
786 There are two families of OCCT objects that can be translated: 
787   * geometrical objects, 
788   * topological shapes. 
789
790 @subsubsection occt_step_3_2_2 Writing assembly structures
791 The shapes organized in a structure of nested compounds can be translated either as simple compound shapes, or into the assembly structure, depending on the parameter *write.step.assembly*, which is described below. 
792
793 The assembly structure placed in the produced STEP file corresponds to the structure described in the ProSTEP Agreement Log (item 21) as the second alternative (assembly structure through *representation_relationship* / *item_defined_transformation*). To represent an assembly it uses entities of the *representation_relationship_with_transformation* type. Transformation operators used for locating assembly components are represented by *item_defined_transformation* entities. 
794 If mode *write.step.assembly* is set to the values *ON* or *Auto* then an OCC shape consisting of nested compounds will be written as an assembly, otherwise it will be written as separate solids. 
795
796 Please see also @ref occt_step_3_4 "Mapping OCCT shapes to STEP entities".
797
798 @subsection occt_step_3_3 Description of the process
799 @subsubsection occt_step_3_3_1 Initializing the process
800 Before performing any other operation you have to create a writer object: 
801 ~~~~~
802 STEPControl_Writer writer; 
803 ~~~~~
804 @subsubsection occt_step_3_3_2 Setting the translation parameters
805
806 The following parameters are used for the OCCT-to-STEP translation. 
807
808 <h4>write.precision.mode</h4>
809
810 writes the precision value. 
811 * Least (-1) :      the uncertainty value is set to the minimum tolerance of an OCCT shape 
812 * Average (0) :   the uncertainty value is set to the average tolerance of an OCCT shape. 
813 * Greatest (1) :  the uncertainty value is set to the maximum tolerance of an OCCT shape 
814 * Session (2) :   the uncertainty value is that of the write.precision.val parameter. 
815
816 Read this parameter with: 
817
818 Standard_Integer ic = Interface_Static::IVal("write.precision.mode"); 
819 Modify this parameter with: 
820 ~~~~~
821 if(!Interface_Static::SetIVal("write.precision.mode",1))  
822 .. error .. 
823 ~~~~~
824 Default value is 0. 
825
826 <h4>write.precision.val</h4>
827 a user-defined precision value. This parameter gives the uncertainty for STEP entities constructed from OCCT shapes when the write.precision.mode parameter value is 1. 
828   * 0.0001: default
829   * any real positive (non null) value. 
830
831 This value is stored in shape_representation in a STEP file as an uncertainty. 
832
833 Read this parameter with: 
834 ~~~~~
835 Standard_Real rp = Interface_Static::RVal("write.precision.val");  
836 ~~~~~
837
838 Modify this parameter with: 
839 ~~~~~
840 if(!Interface_Static::SetRVal("write.precision.val",0.01))  
841 .. error .. 
842 ~~~~~
843 Default value is 0.0001. 
844
845 <h4>write.step.assembly</h4>
846 writing assembly mode. 
847 * 0 (Off) : (default)  writes STEP files without assemblies. 
848 * 1 (On) : writes all shapes in the form of STEP assemblies. 
849 * 2 (Auto) : writes shapes having a structure of (possibly nested) *TopoDS_Compounds* in the form of STEP assemblies, single shapes are written without assembly structures. 
850
851 Read this parameter with: 
852 ~~~~~
853 Standard_Integer rp = Interface_Static::IVal("write.step.assembly"); 
854 ~~~~~
855 Modify this parameter with: 
856 ~~~~~
857 if(!Interface_Static::SetIVal("write.step.assembly",1))  
858 .. error .. 
859 ~~~~~
860 Default value is 0. 
861
862 <h4>write.step.schema</h4>
863 defines the version of schema used for the output STEP file:  
864     * 1 or ;AP214CD; (default): AP214, CD version (dated 26 November 1996), 
865     *  2 or ;AP214DIS;: AP214, DIS version (dated 15 September 1998). 
866     *  3 or ;AP203;: AP203, possibly with modular extensions (depending on data written to a file). 
867     *  4 or *AP214IS*: AP214, IS version (dated 2002) 
868
869 Read this parameter with: 
870 ~~~~~
871 TCollection_AsciiString schema = Interface_Static::CVal("write.step.schema"); 
872 ~~~~~
873 Modify this parameter with: 
874 ~~~~~
875 if(!Interface_Static::SetCVal("write.step.schema","DIS"))  
876 .. error .. 
877 ~~~~~
878 Default value is 1 (;CD;). 
879 For the parameter *write.step.schema* to take effect, method *STEPControl_Writer::Model(Standard_True)* should be called after changing this parameter (corresponding command in DRAW is *newmodel*).
880  
881 <h4>write.step.product.name</h4>
882 Defines the text string that will be used for field ‘name’ of PRODUCT entities written to the STEP file. 
883
884 Default value: OCCT STEP translator (current OCCT version number). 
885
886 <h4>write.surfacecurve.mode</h4>
887 This parameter indicates whether parametric curves (curves in parametric space of surface) should be written into the STEP file. This parameter can be set to Off in order to minimize the size of the resulting STEP file. 
888
889 * Off (0) :            writes STEP files without pcurves. This mode decreases the size of the resulting STEP file . 
890 * On (1) : (default) writes pcurves to STEP file 
891
892 Read this parameter with: 
893 ~~~~~
894 Standard_Integer wp = Interface_Static::IVal("write.surfacecurve.mode"); 
895 ~~~~~
896 Modify this parameter with: 
897 ~~~~~
898 if(!Interface_Static::SetIVal("write.surfacecurve.mode",1))  
899 .. error .. 
900 ~~~~~
901 Default value is On. 
902
903 <h4>write.step.unit</h4>
904 Defines a unit in which the STEP file should be written. If set to unit other than MM,  the model is converted to these units during the translation. 
905
906 Default value is MM. 
907
908 <h4>write.step.resource.name and write.step.sequence</h4>
909 These two parameters define the name of the resource file and the name of the sequence of operators (defined in that file) for Shape Processing, which is automatically performed by the STEP translator before translating a shape to a STEP file. Shape Processing is a user-configurable step, which is performed before the translation and consists in applying a set of operators to a resulting shape. This is a very powerful tool allowing customizing the shape and adapting it to the needs of a receiving application. By default the sequence consists of two operators: SplitCommonVertex and DirectFaces, which convert some geometry and topological constructs valid in Open CASCADE Technology but not in STEP to equivalent definitions conforming to STEP format. 
910
911 See description of parameter read.step.resource.name above for more details on using resource files. 
912
913 Default values:  
914 * read.step.resource.name -- STEP, 
915 * read.step.sequence -- ToSTEP.
916
917 <h4>write.step.vertex.mode</h4>
918 This parameter indicates which of free vertices writing mode is switch on. 
919 * 0 (One Compound) : (default)  All free vertices are united into one compound and exported in one SHAPE DEFINITION REPRESENTATION (vertex name and style are lost). 
920 * 1 (Single Vertex) : Each vertex exported in its own SHAPE DEFINITION REPRESENTATION (vertex name and style are not lost, but size of STEP file increases). 
921
922 Read this parameter with: 
923 ~~~~~
924 Standard_Integer ic = Interface_Static::IVal("write.step.vertex.mode"); 
925 ~~~~~
926 Modify this parameter with: 
927 ~~~~~
928 if(!Interface_Static::SetIVal("write.step.vertex.mode",1))  
929 .. error .. 
930 ~~~~~
931 Default value is 0. 
932  
933 @subsubsection occt_step_3_3_3 Performing the Open CASCADE Technology shape translation
934 An OCCT shape can be translated to STEP using one of the following models (shape_representations): 
935   * manifold_solid_brep (advanced_brep_shape_representation) 
936   * brep_with_voids (advanced_brep_shape_representation) 
937   * faceted_brep (faceted_brep_shape_representation) 
938   * shell_based_surface_model (manifold_surface_shape_representation) 
939   * geometric_curve_set (geometrically_bounded_wireframe_shape_representation) 
940   
941 The enumeration *STEPControl_StepModelType* is intended to define a particular transferring model. 
942 The following values of enumeration are allowed: 
943 * *STEPControl_AsIs* Translator selects the resulting representation automatically, according to the type of CASCADE shape to translate it in its highest possible model;
944 * *STEPControl_ManifoldSolidBrep* resulting entity is manifold_solid_brep or brep_with_voids
945 * *STEPControl_FacetedBrep* resulting entity is *faceted_brep* or   *faceted_brep_and_brep_with_voids* Note that only planar-face shapes with linear edges can be written;
946 * *STEPControl_ShellBasedSurfaceModel* resulting entity is *shell_based_surface_model*;
947 * *STEPControl_GeometricCurveSet* resulting entity is *geometric_curve_set*;
948
949 The following list shows which shapes can be translated in which mode: 
950 * *STEP214Control_AsIs* -- any OCCT shape
951 * *STEP214Control_ManifoldSolidBrep* -- *TopoDS_Solid, TopoDS_Shell, TopoDS_Compound* (if it contains *TopoDS_Solids* and *TopoDS_Shells*.
952 * *STEP214Control_FacetedBrep* -- *TopoDS_Solid* or *TopoDS_Compound* containing *TopoDS_Solids* if all its surfaces are *Geom_Planes* and all curves are *Geom_Lines*.
953 * *STEP214Control_ShellBasedSurfaceModel* -- *TopoDS_Solid, TopoDS_Shell, TopoDS_Face* and *TopoDS_Compound* (if it contains all mentioned shapes)
954 * *STEP214Control_GeometricCurveSet* -- any OCCT shape.
955
956 If *TopoDS_Compound* contains any other types besides the ones mentioned in the table, these sub-shapes will be ignored. 
957
958 In case if an OCCT shape cannot be translated according to its mode the result of translation is void. 
959 ~~~~~
960 STEP214Control_StepModelTope mode = STEP214Control_ManifoldSolidBrep; 
961 IFSelect_ReturnStatus stat = writer.Transfer(shape,mode); 
962 ~~~~~
963
964 @subsubsection occt_step_3_3_4 Writing the STEP file
965 Write the STEP file with: 
966 ~~~~~
967 IFSelect_ReturnStatus stat = writer.Write("filename.stp"); 
968 ~~~~~
969 to give the file name. 
970
971 @subsection occt_step_3_4 Mapping Open CASCADE Technology shapes to STEP entities
972 Only STEP entities that have a corresponding OCCT object and mapping of assembly structures are described in this paragraph. For a full list of STEP entities please refer to Appendix A. 
973
974 @subsubsection occt_step_3_4_1 Assembly structures and product information
975 The assembly structures are written to the STEP file if parameter *write.step.assembly* is 1 or 2. 
976 Each *TopoDS_Compound* is written as an assembly with subshapes of that compound being components of the assembly. The structure of nested compounds is translated to the structure of nested assemblies. Shared subshapes are translated into shared components of assemblies. Shapes that are not compounds are translated into subtypes of shape_representation according to their type (see the next subchapter for details). 
977
978 A set of STEP entities describing general product information is written to the STEP file together with the entities describing the product geometry, topology and assembly structure. Most of these entities are attached to the entities being subtypes of shape_representation, but some of them are created only one per STEP file. 
979
980 The table below describes STEP entities, which are created when the assembly structure and product information are written to the STEP file, and shows how many of these entities are created. Note that the appearance of some of these entities depends on the version of the schema (AP214, CD, DIS or IS, or AP203). 
981
982 | CASCADE shape | STEP entity | Comments | 
983 | :--------- | :------ | :----- | 
984 | | application_protocol_definition | One per STEP file, defines the application protocol used (depends on the schema version) | 
985 | | application_context | One per STEP file, defines the application generating the file (AP214 or AP203) | 
986 | TopoDS_Compound | shape_representation  | Empty *shape_representation* describing the assembly. The components of that assembly are written as subtypes of shape_representation and are included to the assembly using *next_assembly_usage_occurence* entities. | 
987 | TopoDS_Shape  | subtypes of shape_representation  |  Depending on the shape type, see the tables below for mapping details  |
988 |  | next_assembly_usage_occurence | Describes the instance of component in the assembly by referring corresponding *product_definitions*. If the same component is included in the assembly several times (for example, with different locations), several *next_assembly_usage_occurences* are created. |
989 | | context_dependent_shape_representation | Describes the placement of a component in the assembly. One *context_dependent_shape_representation* corresponds to each  *next_assembly_usage_occurence* entity. | 
990 | | shape_representation_relationship_with_transformation | Together with the *context_dependent_shape_representation* describes the location of a component in the assembly. | 
991 | | item_defined_transformation | Defines a transformation used for the location of a component in the assembly. Is referred by *shape_representation_relationship_with_transformation*.  |
992 | | shape_definition_representation | One per *shape_representation*. | 
993 | | product_definition_shape  | One per *shape_definition_representation* and *context_dependent_shape_representation* |
994 | | product_definition | Defines a product, one per *shape_definition_representation* |
995 | | product_definition_formation  | One per *product_definition*. All *product_definition_formations* in the STEP file have unique names. | 
996 | |  Product | One per *product_definition_formation*. All products in the STEP file have unique names. |
997 | | product_type (CD) or product_related_product_category (DIS,IS) | One per product | 
998 | | Mechanical_context (CD) or product_context (DIS,IS) | One per product.  | 
999 | | product_definition_context | One per *product_definition*.  |
1000
1001   
1002 @subsubsection occt_step_3_4_2 Topological shapes
1003
1004 | CASCADE shape | STEP entity | Comments | 
1005 | :----- | :---- | :----- | 
1006 | TopoDS_Compound | geometric_curve_set | If the write mode is *STEP214Control_GeometricCurveSet* only 3D curves of the edges found in *TopoDS_Compound* and all its subshapes are translated |
1007 | | manifold_solid_brep | If the write mode is *STEP214Control_AsIs* and *TopoDS_Compound* consists only of *TopoDS_Solids*. |
1008 | | shell_based_surface_model | If the write mode is *STEP214Control_AsIs* and *TopoDS_Compound* consists of *TopoDS_Solids*, *TopoDS_Shells* and *TopoDS_Faces*.|
1009 | | geometric_curve_set | If the write mode is *STEP214Control_AsIs* and *TopoDS_Compound* contains *TopoDS_Wires, TopoDS_Edges, TopoDS_Vertices*. If the write mode is not *STEP214Control_AsIs* or *STEP214Control_GeometricCurveSet*, *TopoDS_Solids, TopoDS_Shells* and *TopoDS_Faces* are translated according to this table. |
1010 | TopoDS_Solid | manifold_solid_brep | If the write mode is *STEP214Control_AsIs* or *STEP214Control_ManifoldSolidBrep* and CASCADE *TopoDS_Solid* has no voids. | 
1011 | | faceted_brep | If the write mode is *STEP214Control_FacetedBrep*. |
1012 | | brep_with_voids | If the write mode is *STEP214Control_AsIs* or *STEP214Control_ManifoldSolidBrep* and CASCADE *TopoDS_Solid* has voids. |
1013 | | shell_based_surface_model | If the write mode is *STEP214Control_ShellBasedSurfaceModel*. | 
1014 | | geometric_curve_set | If the write mode is *STEP214Control_GeometricCurveSet*. Only 3D curves of the edges are translated. | 
1015 | TopoDS_Shell in a TopoDS_Solid | closed_shell | If *TopoDS_Shell* is closed shell. | 
1016 | TopoDS_Shell | manifold_solid_brep | If the write mode is *STEP214Control_ManifoldSolidBrep*. |
1017 | | shell_based_surface_model | If the write mode is *STEP214Control_AsIs* or *STEP214Control_ShellBasedSurfaceModel*. | 
1018 | | geometric_curve_set | If the write mode is *STEP214Control_GeometricCurveSet*. Only 3D curves of the edges are translated. | 
1019 | TopoDS_Face | advanced_face | |
1020 | TopoDS_Wire in a TopoDS_Face | face_bound | The resulting *face_bound* contains *poly_loop* if write mode is *faceted_brep* or *edge_loop* if it is not. | 
1021 | TopoDS_Wire | geometric_curve_set | If the write mode is *STEP214Control_GeometricCurveSet*. Only 3D curves of the edges are translated. |
1022 | TopoDS_Edge | oriented_edge | |
1023 | TopoDS_Vertex | vertex_point | | 
1024
1025 @subsubsection occt_step_3_4_3 Geometrical objects
1026 | Geometry | CASCADE object | STEP entity | Comments | 
1027 | :----- | :------ | :----- | :----- | 
1028 | Points | Geom_CartesianPoint, Geom2d_CartesianPoint |  cartesian_point | |
1029 | | TColgp_Array1OfPnt, TColgp_Array1OfPnt2d | polyline  | | 
1030 | Placements | Geom_Axis1Plasement, Geom2d_AxisPlacement | axis1_placement | | 
1031 | | Geom_Axis2Placement | axis2_placement_3d | | 
1032 | Directions | Geom_Direction, Geom2d_Direction  | direction | |
1033 | Vectors | Geom_Vector, Geom2d_Vector | vector | |
1034 | Curves | Geom_Circle | circle | |
1035 | | Geom2d_Circle | circle, rational_b_spline_curve | |
1036 | | Geom_Ellipse | Ellipse | |
1037 | | Geom2d_Ellipse | Ellipse, rational_b_spline_curve | |
1038 | | Geom_Hyperbola, Geom2d_Hyperbola |  Hyperbola | |
1039 | | Geom_Parabola, Geom2d_Parabola | Parabola | | 
1040 | | Geom_BSplineCurve | b_spline_curve_with_knots or rational_b_spline_curve | *rational_b_spline_curve* is produced if *Geom_BsplineCurve* is a rational BSpline |
1041 | |  Geom2d_BSplineCurve | b_spline_curve_with_knots or rational_b_spline_curve | *rational_b_spline_curve* is produced if *Geom2d_BsplineCurve* is a rational BSpline |
1042 | | Geom_BezierCurve | b_spline_curve_with_knots | |
1043 | | Geom_Line  or Geom2d_Line | Line | |
1044 | Surfaces | Geom_Plane | Plane | |
1045 | | Geom_OffsetSurface | offset_surface | |
1046 | | Geom_ConicalSurface | conical_surface | | 
1047 | | Geom_CylindricalSurface | cylindrical_surface | | 
1048 | | Geom_OffsetSurface | offset_surface | | 
1049 | | Geom_RectangularTrimmedSurface | rectangular_trimmed_surface | | 
1050 | | Geom_SphericalSurface |  spherical_surface | | 
1051 | | Geom_SurfaceOfLinear Extrusion | surface_of_linear_extrusion | | 
1052 | | Geom_SurfaceOf Revolution | surface_of_revolution | |
1053 | | Geom_ToroidalSurface | toroidal_surface or degenerate_toroidal_surface |   *degenerate_toroidal_surface* is produced if the minor radius is greater then the major one |
1054 | | Geom_BezierSurface | b_spline_surface_with_knots | | 
1055 | | Geom_BsplineSurface | b_spline_surface_with_knots or rational_b_spline_surface |  *rational_b_spline_surface* is produced if *Geom_BSplineSurface* is a rational Bspline |
1056
1057
1058 @subsection occt_step_3_5 Tolerance management
1059 There are four possible values for the uncertainty when writing a STEP file: 
1060   * user-defined value of the uncertainty 
1061   * minimal value of sub-shapes tolerances 
1062   * average value of sub-shapes tolerances 
1063   * maximal value of sub-shapes tolerances 
1064   
1065 The chosen value of the uncertainty is the final value that will be written into the STEP file. 
1066 See parameter *write.precision.mode*. 
1067
1068
1069 @subsection occt_step_3_6 Code architecture
1070
1071 @subsubsection occt_step_3_6_1 Graph of calls
1072 The following diagram illustrates the structure of calls in writing STEP. 
1073 The highlighted classes are intended to translate geometry. 
1074
1075
1076 @image html /user_guides/step/images/step_image004.png "The structure of calls in writing STEP"
1077 @image latex /user_guides/step/images/step_image004.png "The structure of calls in writing STEP"
1078
1079     
1080 @subsection occt_step_3_7 Example
1081 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
1082 #include <STEPControl.hxx> 
1083 #include <STEPControl_Writer.hxx> 
1084 #include <TopoDS_Shape.hxx> 
1085 #include <BRepTools.hxx> 
1086 #include <BRep_Builder.hxx> 
1087
1088 Standard_Integer main() 
1089
1090 TopoDS_Solid source; 
1091 . . . 
1092
1093 STEPControl_Writer writer; 
1094 writer.Transfer(source, STEPControl_ManifoldSolidBrep); 
1095
1096 // Translates TopoDS_Shape into manifold_solid_brep entity 
1097 writer.Write(;Output.stp;); 
1098 // writes the resulting entity in the STEP file 
1099
1100
1101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1102
1103 @section occt_step_4 Physical STEP file reading and writing
1104
1105 @subsection occt_step_4_1 Architecture of STEP Read and Write classes
1106 @subsubsection occt_step_4_1_1 General principles
1107
1108 To perform data loading from a STEP file and to translate this data it is necessary to create correspondence between the EXPRESS schema and the structure of the classes. There are two possibilities to organize such correspondence: the so-called early binding and late binding. 
1109 * Late binding means that the processor works with a description of the schema. The processor builds a dictionary of entities and can recognize and read any entity that is described in the schema. To change the behavior and the scope of processor based on late binding it is enough to change the description of the schema. However, this binding has some disadvantages (for example low speed of reading process). 
1110 * In case of early binding, the structure of the classes is created beforehand with the help of a specific automatic tool or manually. If the processor finds an entity that is not found in this schema, it will simply be ignored. The processor calls constructors of appropriate classes and their read methods. To add a new type in the scope of the processor it is necessary to create a class corresponding to the new entity. 
1111
1112 The STEP processor is based on early binding principles. It means that specific classes for each EXPRESS type have been created with the help of an automatic tool from the EXPRESS schema. There are two classes for each EXPRESS type. The first class (named the representing class) represents the STEP entity in memory. The second one (RW-class) is intended to perform the initialization of the representing class and to output data to an intermediate structure to be written in a STEP file. 
1113
1114 @subsubsection occt_step_4_1_2 Complex entities
1115 EXPRESS schema allows multiple inheritance. Entities that are built on the basis of multiple inheritance are called complex entities. EXPRESS enables any type of complex entities that can be inherited from any EXPRESS type. In the manner of early binding it is not possible to create a C++ class for any possible complex type. Thus, only widespread complex entities have corresponding representing classes and RW-classes that are created manually beforehand. 
1116
1117 @subsection occt_step_4_2 Physical file reading
1118 Physical file reading consists of the following steps: 
1119    1.Loading a STEP file and syntactic analysis of its contents 
1120    2.Mapping STEP entities to the array of strings 
1121    3.Creating empty OCCT objects representing STEP entities 
1122    4.Initializing OCCT objects 
1123    5.Building a references graph 
1124    
1125 @subsubsection occt_step_4_2_1 Loading a STEP file and syntactic analysis of its contents
1126 In the first phase, a STEP file is syntactically checked and loaded in memory as a sequence of strings. 
1127
1128 Syntactic check is performed on the basis of rules defined in *step.lex* and *step.yacc* files. Files *step.lex* and *step.yacc* are located in the StepFile nocdlpack development unit. These files describe text encoding of STEP data structure (for additional information see ISO 10303 Part 21). The *step.lex* file describes the lexical structure of the STEP file. It describes identifiers, numbers, delimiters, etc. The *step.yacc* file describes the syntactic structure of the file, such as entities, parameters, and headers. 
1129
1130 These files have been created only once and need to be updated only when norm ISO 10303-21 is changed. 
1131
1132 @subsubsection occt_step_4_2_2 Mapping STEP entities to arrays of strings
1133 For each entity specified by its rank number the arrays storing its identifier, STEP type and parameters are filled. 
1134 @subsubsection occt_step_4_2_3 Creating empty Open CASCADE Technology objects that represent STEP entities
1135 For each STEP entity an empty OCCT object representing this entity is created. A map of correspondence between entity rank and OCCT object is created and filled out. If a STEP entity is not recognized by the STEP processor then the *StepData_UndefinedEntity* object is created. 
1136 @subsubsection occt_step_4_2_4 Initializing Open CASCADE Technology objects
1137 Each OCCT object (including StepData_UndefinedEntity) is initialized by its parameters with the help of the appropriate RW-class. If an entity has another entity as its parameter, the object that represents the latter entity will be initialized immediately. All initialized objects are put into a special map to avoid repeated initialization. 
1138 @subsubsection occt_step_4_2_5 Building a graph
1139 The final phase is building a graph of references between entities. For each entity its RW-class is used to find entities referenced by this entity. Back references are built on the basis of direct references. In addition to explicit references defined in the STEP entities some additional (implicit) references are created for entities representing assembly structures (links from assemblies to their components). 
1140 @subsection occt_step_4_3 How to add a new entity in scope of the STEP processor
1141 If it is necessary to read and translate a new entity by the STEP processor the Reader and Actor scope should be enhanced. Note that some actions to be made for adding a new type are different for simple and complex types. 
1142 The following steps should be taken: 
1143 * Create a class representing a new entity. This can be *Stepxxx_NewEntity* class where xxx can be one of the following: 
1144      * Basic 
1145      * Geom 
1146      * Shape 
1147      * Visual 
1148      * Repr 
1149      * AP214 
1150      * AP203 
1151 Each field of a STEP entity should be represented by a corresponding field of this class. The class should have methods for initializing, setting and obtaining fields and it should also have the default constructor. 
1152 * Create the *RWStepxxx_RWNewEntity* class with a default constructor and methods *ReadStep()*, *WriteStep()* and if the entity references other entities, then method *Share()*. 
1153 * Update file *StepAP214_Protocol.cxx*. In the constructor *StepAP214_Protocol::StepAP214_Protocol()* add the new type to the map of registered types and associate the unique integer identifier with this type. 
1154 * Update file *RWStepAP214_ReadWriteModule.cxx*. The changes should be the following: 
1155  * For simple types: 
1156     * Add a static object of class *TCollection_AsciiString* with name *Reco_NewEntity* and initialize it with a string containing the STEP type. 
1157     * In constructor *WStepAP214_ReadWriteModule::RWStepAP214_ReadWriteModule()* add this object onto the list with the unique integer identifier of the new entity type. 
1158     * In function *RWStepAP214_ReadWriteModule::StepType()* add a new C++ case operator for this identifier. 
1159  * For complex types: 
1160     * In the method *RWStepAP214_ReadWriteModule::CaseStep()* add a code for recognition the new entity type returning its unique integer identifier. 
1161     * In the method *RWStepAP214_ReadWriteModule::IsComplex()* return True for this type. 
1162     * In the method *RWStepAP214_ReadWriteModule::ComplexType()* fill the list of subtypes composing this complex type. 
1163  * For both simple and complex types: 
1164   * In function *RWStepAP214_ReadWriteModule::ReadStep()* add a new C++ case operator for the new identifier and call the *RWStepxxx_RWNewEntity* class, method *ReadStep* to initialize the new class. 
1165 * Update file *RWStepAP214_GeneralModule.cxx*. Add new C++ case operators to functions *NewVoid()* and *FillSharedCase()*, and in the method *CategoryNumber()* add a line defining a category of the new type. 
1166 * Enhance the *STEPControl_ActorRead class* (methods *Recognize()* and *Transfer()*), or class(es) translating some entities, to translate the new entity into an OCCT shape. 
1167
1168 @subsection occt_step_4_4 Physical file writing
1169 Physical file writing consists of the following steps: 
1170    1. Building a references graph. Physical writing starts when STEP model, which was either loaded from a STEP file or created from OCCT shape with the help of translator, is available together with corresponding graph of references. During this step the graph of references can be recomputed. 
1171    2. Transferring data from a model to a sequence of strings. For each representing entity from the model a corresponding RW-class is called. RW-class writes data that is contained in the representing class into an intermediate data structure. The mentioned structure is a sequence of strings in memory. 
1172    3. Writing the sequence of strings into the file. The sequence of strings is written into the file. This is the last phase of physical STEP writing.
1173    
1174
1175 @subsection occt_step_4_5 How to add a new entity to write in the STEP file.
1176
1177 If it is necessary to write and translate an OCCT shape into a new entity by the STEP processor the Writer and Actor scope should be enhanced. 
1178
1179 For a description of steps, which should be taken for adding a new entity type to the STEP processor, see @ref occt_step_4_2 "Physical file reading". Then, enhance the *STEPControl_ActorWrite* class i.e. methods *Recognize()* and *Transfer()*, or other classes from *TopoDSToStep*, to translate the OCCT shape into a new STEP entity. 
1180
1181 @section occt_step_6 Using DRAW
1182 @subsection occt_step_6_1 DRAW STEP Commands Overview
1183 *TKXSDRAW* toolkit provides commands for testing XSTEP interfaces interactively in the DRAW environment. It provides an additional set of DRAW commands specific for data exchange tasks, which allows loading and writing data files and an analysis of the resulting data structures and shapes.  
1184
1185 This section is divided into five parts. Two of them deal with reading and writing a STEP file and are specific for the STEP processor. The first and the forth parts describe some general tools for setting parameters and analyzing the data. Most of them are independent of the norm being tested. Additionally, a table of mentioned DRAW commands is provided. 
1186
1187 In the description of commands, square brackets ([]) are used to indicate optional parameters. Parameters given in the angle brackets (\<\>) and sharps (#) are to be substituted by an appropriate value. When several exclusive variants are possible, a vertical dash (|) is used.
1188  
1189 @subsection occt_step_6_2 Setting the interface parameters
1190 A set of parameters for importing and exporting STEP data is defined in the XSTEP resource file. In XSDRAW, these parameters can be viewed or changed using the command 
1191 ~~~~~
1192 Draw:> param [<parameter_name> [<value>]] 
1193 ~~~~~
1194 Command *param* with no arguments gives a list of all parameters with their values. When the argument *parameter_name* is specified, information about this parameter is printed (current value and short description). 
1195
1196 The third argument is used to set a new value of the given parameter. The result of the setting is printed immediately. 
1197
1198 During all interface operations, the protocol of the process (fail and warning messages, mapping of loaded entities into OCCT shapes etc.) can be output to the trace file. Two parameters are defined in the DRAW session: trace level (integer value from 0 to 9, default is 0), and trace file (default is standard output). 
1199
1200 Command xtrace is intended to view and change these parameters: 
1201 * *Draw:> xtrace* -- prints current settings (e.g.: `Level=1 - Standard Output'); 
1202 * *Draw:> xtrace \#* -- sets trace level to the value #; 
1203 * *Draw:> xtrace tracefile.log* -- sets the trace file as *tracefile.log*;
1204 * *Draw:> xtrace.* -- directs all messages to the standard output. 
1205
1206 @subsection occt_step_6_3 Reading a STEP file
1207
1208 For a description of parameters used in reading a STEP file refer to @ref occt_step_2_3_3 "Setting the translation parameters" section.
1209
1210 For reading a STEP file, the following parameters are defined (see above, @ref occt_step_6_2 "the command *param*"):
1211
1212 | Description | Name | Values | Meaning |
1213 | :------------ | :---- | :------- | :------- |
1214 | Precision for input entities | read.precision.mode | 0 or 1 | If 0 (File), precision of the input STEP file will be used for the loaded shapes; If 1 (Session), the following parameter will be used as the precision value. | 
1215 | | read.precision.val | real | Value of precision (used if the previous parameter is 1) | 
1216 | Surface curves | read.surfacecurve.mode |  0 or 3  | Defines a preferable way of representing surface curves (2d or 3d representation). If 0, no preference. | 
1217 | Maximal tolerance | read.maxprecision.mode | 0 or 1 | If 1, maximum tolerance is used as a rigid limit If 0, maximum tolerance is used as a limit but can be exceeded by some algorithms. | 
1218 | | read.maxprecision.val | real | Value of maximum precision | 
1219
1220 It is possible either only to load a STEP file into memory (i.e. fill the *InterfaceModel* with data from the file), or to read it (i.e. load and convert all entities to OCCT shapes). 
1221 Loading is done by the command 
1222 ~~~~~
1223 Draw:> xload <file_name>
1224 ~~~~~
1225 Once the file is loaded, it is possible to investigate the structure of the loaded data. To find out how you do it, look in the beginning of the analysis subsection. 
1226 Reading a STEP file is done by the command 
1227 ~~~~~
1228 Draw:> stepread <file_name> <result_shape_name> [selection] 
1229 ~~~~~
1230 Here a dot can be used instead of a filename if the file is already loaded by xload or stepread. 
1231 The optional selection (see below for a description of selections) specifies a set of entities to be translated. If an asterisk `*' is given, all transferable roots are translated. If a selection is not given, the user is prompted to define a scope of transfer interactively: 
1232
1233 | N | Mode | Description |
1234 | :---- | :---- | :---- |  
1235 | 0 | End | Finish transfer and exit stepread | 
1236 | 1 | root with rank 1 | Transfer first root | 
1237 | 2 | root by its rank | Transfer root specified by its rank | 
1238 | 3 | One entity | Transfer entity with a number provided by the user | 
1239 | 4 | Selection | Transfer only entities contained in selection | 
1240
1241 * root is an entity in the STEP file which is not referenced by another entities 
1242 Second parameter of the stepread command defines the name of the loaded shape. 
1243
1244 During the STEP translation, a map of correspondence between STEP entities and OCCT shapes is created. 
1245
1246 To get information on the result of translation of a given STEP entity use the command @code Draw:> tpent #*.@endcode 
1247
1248 To create an OCCT shape, corresponding to a STEP entity, use the command @code Draw:> tpdraw #*. @endcode 
1249
1250 To get the number of a STEP entity, corresponding to an OCCT shape, use the command @code Draw:> fromshape <shape_name>. @endcode 
1251
1252 To clear the map of correspondences between STEP entities and OCCT shapes use the command @code Draw:> tpclear. @endcode
1253  
1254 @subsection occt_step_6_4 Analyzing the transferred data 
1255
1256 The procedure of analysis of data import can be divided into two stages: 
1257    1. to check the file contents, 
1258    2. to estimate the translation results (conversion and validated ratios). 
1259
1260 @subsubsection occt_step_6_4_1 Checking file contents
1261
1262 General statistics on the loaded data can be obtained by using the command 
1263
1264 ~~~~
1265 Draw:> data <symbol> 
1266 ~~~~
1267
1268 Information printed by this command depends on the symbol specified: 
1269
1270 * *g* -- Prints the information contained in the header of the file;
1271 * *c* or *f* -- Prints messages generated during the loading of the STEP file (when the procedure of the integrity of the loaded data check is performed) and the resulting statistics (f works only with fails while c with both fail and warning messages) ;
1272 * *t* -- The same as *c* or *f*, with a list of failed or warned entities;
1273 * *m* or *l* -- The same as *t* but also prints a status for each entity;
1274 * *e*  -- Lists all entities of the model with their numbers, types, validity status etc;
1275 * *R* -- The same as e but lists only root entities.
1276
1277 There is a set of special objects, which can be used to operate with a loaded model. They can be of the following types: 
1278 * Selection Filters -- allow selecting subsets of entities of the loaded model;
1279 * Counter -- calculates some statistics on the model data.
1280
1281 A list of these objects defined in the current session can be printed in DRAW by command @code Draw:> listitems. @endcode 
1282
1283 Command @code Draw:> givelist <selection_name> @endcode prints a list of a subset of loaded entities defined by the <i>\<selection\></i> argument: 
1284
1285 * *xst-model-all* all entities of the model;
1286 * *xst-model-roots* all roots;
1287 * *xst-pointed* (Interactively) pointed entities (not used in DRAW);
1288 * *xst-transferrable-all* all transferable (recognized) entities;
1289 * *xst-transferrable-roots* Transferable roots.
1290
1291 The command *listtypes* gives a list of entity types, which were encountered in the last loaded file (with a number of STEP entities of each type). 
1292
1293 The list cannot be shown for all entities but for a subset of them. This subset is defined by an optional selection argument (for the list of possible values for STEP, see the table above).
1294  
1295 Two commands are used to calculate statistics on the entities in the model: 
1296 ~~~~~
1297 Draw:> count <counter> [<selection>] 
1298 Draw:> listcount <counter> [<selection>] 
1299 ~~~~~
1300 The former only prints a count of entities while the latter also gives a list of them. 
1301
1302 The optional selection argument, if specified, defines a subset of entities, which are to be taken into account. The first argument should be one of the currently defined counters: 
1303 * *xst-types* -- calculates how many entities of each OCCT type exist
1304 * *step214-types* -- calculates how many entities of each STEP type exist
1305
1306 Entities in the STEP file are numbered in the succeeding order. An entity can be identified either by its number or by its label. Label is the letter \# followed by the rank. 
1307 * *Draw:> elab \#* outputs a label for an entity with a known number. 
1308 * *Draw:> enum \#* prints a number for the entity with a given label. 
1309 * *Draw:> entity \# \<level_of_information\>* outputs the contents of a STEP entity. 
1310 * *Draw: estat \#* outputs the list of entities referenced by a given entity and the list of entities referencing to it. 
1311 * *Draw: dumpassembly* prints a STEP assembly as a tree.
1312
1313 Information about product names, *next_assembly_usage_occurence, shape_definition_representation, context_dependent_shape_representation* or *mapped_item entities* that are involved into the assembly structure will be printed. 
1314
1315 @subsubsection occt_step_6_4_2 Estimating the results of reading STEP
1316 All the following commands are available only after data is converted into OCCT shapes (i.e. after command 214read). 
1317
1318 Command *Draw:> tpstat [*|?]\<symbol\> [\<selection\>]* is provided to get all statistics on the last transfer, including a list of transferred entities with mapping from STEP to OCCT types, as well as fail and warning messages. The parameter <i>\<symbol\></i> defines what information will be printed: 
1319
1320 * *g* -- General statistics (a list of results and messages)
1321 * *c* -- Count of all warning and fail messages
1322 * *C* -- List of all warning and fail messages
1323 * *f* -- Count of all fail messages
1324 * *F* -- List of all fail messages
1325 * *n* -- List of all transferred roots
1326 * *s* -- The same, with types of source entity and the type of result
1327 * *b* -- The same, with messages
1328 * *t* -- Count of roots for geometrical types
1329 * *r* -- Count of roots for topological types
1330 * *l* -- The same, with the type of the source entity
1331
1332 The sign \* before parameters *n, s, b, t, r* makes it work on all entities (not only on roots).
1333
1334 The sign ? before *n, s, b, t* limits the scope of information to invalid entities. 
1335
1336 Optional argument <i>\<selection\></i> can limit the action of the command to the selection, not to all entities. 
1337
1338 To get help, run this command without arguments. 
1339
1340 The command *Draw:> tpstat \*1* gives statistics on the result of translation of different types of entities (taking check messages into account) and calculates summary translation ratios. 
1341
1342 To get information on OCCT shape contents use command *Draw:> statshape \<shape_name\>* . It outputs the number of each kind of shapes (vertex, edge, wire, etc.) in the shape and some geometrical data (number of C0 surfaces, curves, indirect surfaces, etc.). 
1343
1344 The number of faces is returned as a number of references. To obtain the number of single instances, the standard command (from TTOPOLOGY executable) nbshapes can be used. 
1345
1346 To analyze the internal validity of the shape, use command *Draw:> checkbrep \<shape_name\> \<expurged_shape_name\>*. It checks shape geometry and topology for different cases of inconsistency, like self-intersecting wires or wrong orientation of trimming contours. If an error is found, it copies bad parts of the shape with the names <i>expurged_subshape_name _\#</i> and generates an appropriate message. If possible this command also tries to find STEP entities the OCCT shape was produced from. 
1347
1348 <i>\<expurged_shape_name\></i> will contain the original shape without invalid subshapes. 
1349 To get information on tolerances of the shape use command <i>Draw:> tolerance \<shape_name\> [\<min\> [\<max\>] [\<symbol\>]] </i>. It outputs maximum, average and minimum values of tolerances for each kind of subshapes having tolerances and for the whole shape in general. 
1350
1351 When specifying min and max arguments this command saves shapes with tolerances in the range [min, max] with names shape_name_... and gives their total number. 
1352
1353 <i>\<Symbol\></i> is used for specifying the kind of sub-shapes to analyze: 
1354 * *v* -- for vertices, 
1355 * *e* -- for edges, 
1356 * *f* -- for faces, 
1357 * *c* -- for shells and faces. 
1358
1359 @subsection occt_step_6_5 Writing a STEP file
1360 For writing shapes to a STEP file, the following parameters are defined (see above, @ref occt_step_6_2 "the command *param*"):
1361
1362 | Description | Name | Values | Meaning | 
1363 | :------------ | :----- | :------ | :------- | 
1364 | Uncertainty for resulting entities | Write.precision.mode | -1, 0, 1 or 2 | If -1 the uncertainty value is set to the minimal tolerance of CASCADE subshapes. If 0 the uncertainty value is set to the average tolerance of CASCADE subshapes. If 1 the uncertainty value is set to the maximal tolerance of CASCADE subshapes. If 2 the uncertainty value is set to write.precision.val |
1365 | Value of uncertainty | Write.precision.val | real | Value of uncertainty (used if previous parameter is 2). | 
1366
1367 Several shapes can be written in one file. To start writing a new file, enter command *Draw:> newmodel*. 
1368 Actually, command *newmodel* will clear the *InterfaceModel* to empty it, and the next command will convert the specified shape to STEP entities and add them to the *InterfaceModel*: 
1369
1370 ~~~~~
1371 Draw:> stepwrite <mode> <shape_name> [<file_name>] 
1372 ~~~~~
1373
1374 The following  modes are available : 
1375     * *a* -- "as is" -- the mode is selected automatically depending on the type & geometry of the shape;
1376     * *m* -- *manifold_solid_brep* or *brep_with_voids* 
1377     * *f* -- *faceted_brep* 
1378     * *w* -- *geometric_curve_set* 
1379     * *s* -- *shell_based_surface_model* 
1380  
1381 After a successful translation, if *file_name* parameter is not specified, the procedure asks you whether to write a STEP model in the file or not: 
1382 ~~~~~
1383 execution status : 1 
1384 Mode (0 end, 1 file) : 
1385 ~~~~~
1386 It is necessary to call command *newmodel* to perform a new translation of the next OCCT shape. 
1387
1388 @section occt_step_7 Reading from and writing to STEP
1389
1390 The *STEPCAFControl* package (TKXDESTEP toolkit) provides tools to read and write STEP files (see XDE User’s Guide). 
1391
1392 In addition to the translation of shapes implemented in basic translator, it provides the following: 
1393   * STEP assemblies, read as OCCT compounds by basic translator, are translated to XDE assemblies;
1394   * Names of products are translated and assigned to assembly components and instances in XDE;
1395   * STEP external references are recognized and translated (if external documents are STEP files);
1396   * Colors, layers, materials and validation properties assigned to parts or subparts are translated;
1397   * STEP dimensional tolerances are translated.
1398   
1399 @subsection occt_step_7_1 Reading from STEP
1400
1401 ### Load a STEP file
1402 Before performing any other operation, you must load a STEP file with: 
1403 ~~~~~
1404 STEPCAFControl_Reader reader(XSDRAW::Session(), Standard_False); 
1405 IFSelect_ReturnStatus stat = reader.ReadFile("filename.stp"); 
1406 ~~~~~
1407 Loading the file only memorizes the data, it does not translate it. 
1408
1409 ### Check the loaded STEP file
1410 This step is not obligatory. See a description of this step in section @ref occt_step_2_3_2 "Checking the STEP file". 
1411
1412 ### Set parameters for translation to XDE
1413
1414 See a description of this step in section @ref occt_step_2_3_3 "Setting the translation parameters". 
1415
1416 In addition, the following parameters can be set for XDE translation of attributes: 
1417   *  Parameter for transferring colors: 
1418 ~~~~~  
1419 reader.SetColorMode(mode); 
1420 // mode can be Standard_True or Standard_False 
1421 ~~~~~
1422   *  Parameter for transferring names: 
1423 ~~~~~    
1424 reader.SetNameMode(mode); 
1425 // mode can be Standard_True or Standard_False 
1426 ~~~~~
1427
1428 ### Translate a STEP file to XDE
1429
1430 The following function performs a translation of the whole document: 
1431 ~~~~~
1432 Standard_Boolean ok = reader.Transfer(doc); 
1433 ~~~~~
1434 where *doc* is a variable which contains a handle to the output document and should have a type *Handle(TDocStd_Document)*. 
1435
1436 @subsection occt_step_7_2 Writing to STEP
1437
1438 The translation from XDE to STEP can be initialized as follows: 
1439 ~~~~~
1440 STEPCAFControl_Writer aWriter(XSDRAW::Session(),Standard_False); 
1441 ~~~~~
1442
1443 ### Set parameters for translation from XDE to STEP
1444
1445 The following parameters can be set for a translation of attributes to STEP: 
1446   *  For transferring colors: 
1447 ~~~~~
1448 aWriter.SetColorMode(mode); 
1449 // mode can be Standard_True or Standard_False 
1450 ~~~~~
1451   *  For transferring names: 
1452 ~~~~~
1453 aWriter.SetNameMode(mode); 
1454 // mode can be Standard_True or Standard_False 
1455 ~~~~~
1456
1457 ### Translate an XDE document to STEP
1458
1459 You can perform the translation of document by calling the function: 
1460 ~~~~~
1461 IFSelect_ReturnStatus aRetSt = aWriter.Transfer(doc); 
1462 ~~~~~
1463 where *doc*  is a variable, which contains a handle to the input document for transferring and should have a type *Handle(TDocStd_Document)*. 
1464
1465 ### Write a STEP file
1466
1467 Write a STEP file with: 
1468 ~~~~~
1469 IFSelect_ReturnStatus statw = aWriter.WriteFile("filename.stp"); 
1470 ~~~~~
1471 or 
1472 ~~~~~
1473 IFSelect_ReturnStatus statw = writer.WriteFile (S); 
1474 ~~~~~
1475 where *S* is *OStream*. 
1476
1477
1478