d6685e6a413f3c7d734af62c4086b11f3c65e952
[occt.git] / src / RWStl / RWStl.cdl
1 -- File:        RWStl.cdl
2 -- Created:     Thu Oct 13 12:57:13 1994
3 -- Author:      Marc LEGAY
4 --              <mle@bourdon>
5 ---Copyright:    Matra Datavision 1994
6
7 package RWStl 
8
9         ---Purpose: This package contains the methods to be used in 
10         --          the Stereo Lithograpy Application. The main 
11         --          features of this application are ,starting from a 
12         --          Shape :
13         --          - mesh this shape with a maximun tolerance,
14         --          - display the meshing,
15         --          - write the meshing in a file (binary or ascii),
16         --          - read of file (binary or ascii) and display it,
17         --          - translate a binary file to an ascii file,
18         --          - translate an ascii file to an binary file. 
19                                                                         
20 uses 
21
22     OSD, 
23     Standard, 
24     StlMesh 
25     
26 is 
27
28         WriteBinary (aMesh : Mesh from StlMesh; aPath : Path from OSD) 
29                 returns Boolean from Standard;
30           ---Purpose : write the meshing in a file following the 
31           --         binary format of an STL file.
32           --         Returns false if the cannot be opened;             
33
34         WriteAscii (aMesh : Mesh from StlMesh; aPath : Path from OSD) 
35                 returns Boolean from Standard;
36           ---Purpose : write the meshing in a file following the 
37           --         Ascii  format of an STL file.              
38           --         Returns false if the cannot be opened;             
39
40
41         ReadFile   (aPath : Path from OSD) returns
42                 Mesh from StlMesh;
43           ---Purpose : This method will chwck if the file is a binary 
44           --         file or an AsciiFile testing  the 5 first 
45           --         characters of the file wich are :"solid" in an 
46           --         ascii file. If we do not find that word we assume 
47           --         that it is a binary file.  
48
49         ReadBinary (aPath : Path from OSD) returns 
50                 Mesh from StlMesh;
51          ---Purpose : Read a meshing from a binary file
52          --        Raises NoMoreObject from Standard if a statement 
53          --        does not contain the right number of tokens
54          --        Raises TypeMisMatch if a token has not the good 
55          --        type (often real)
56
57         ReadAscii (aPath : Path from OSD) returns 
58                 Mesh from StlMesh;
59          ---Purpose : Read a meshing from a binary file
60          --        Raises NoMoreObject from Standard if a statement 
61          --        does not contain the right number of tokens
62          --        Raises TypeMisMatch if a token has not the good 
63          --        type (often real)
64          --        Raises MoMoreObject if a file is finished before 
65          --        having found the word endsolid;
66
67 end RWStl;
68
69
70