0024624: Lost word in license statement in source files
[occt.git] / src / BRepToIGES / BRepToIGES_BREntity.cdl
CommitLineData
b311480e 1-- Created on: 1994-11-15
2-- Created by: Marie Jose MARTZ
3-- Copyright (c) 1994-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 8-- This library is free software; you can redistribute it and/or modify it under
9-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1 10-- by the Free Software Foundation, with special exception defined in the file
11-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12-- distribution for complete text of the license and disclaimer of any warranty.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class BREntity from BRepToIGES
18
19
20 ---Purpose : provides methods to transfer BRep entity from CASCADE to IGES.
21
22uses
23 Geometry from Geom,
24 Shape from TopoDS,
25 IGESEntity from IGESData,
26 IGESModel from IGESData,
27 FinderProcess from Transfer
28
29is
30
31 Create
32 returns BREntity from BRepToIGES;
33 ---Purpose : Creates a tool BREntity
34
35 Init(me : in out);
36 ---Purpose : Initializes the field of the tool BREntity with
37 -- default creating values.
38
39 SetModel(me : in out; model : IGESModel from IGESData);
40 ---Purpose : Set the value of "TheModel"
41
42 GetModel(me)
43 returns IGESModel from IGESData;
44 ---Purpose : Returns the value of "TheModel"
45
46 GetUnit(me)
47 returns Real from Standard;
48 ---Purpose : Returns the value of the UnitFlag of the header of the model
49 -- in meters.
50
51 SetTransferProcess(me : in out; TP : FinderProcess from Transfer);
52 ---Purpose : Set the value of "TheMap"
53
54 GetTransferProcess(me)
55 returns FinderProcess from Transfer;
56 ---Purpose : Returns the value of "TheMap"
57
58 TransferShape(me : in out; start : Shape from TopoDS)
59 returns IGESEntity from IGESData is virtual;
60 ---Purpose : Returns the result of the transfert of any Shape
61 -- If the transfer has failed, this member return a NullEntity.
62
63 AddFail (me : in out; start : Shape from TopoDS; amess : CString)
64 is static;
65 ---Purpose : Records a new Fail message
66
67 AddWarning (me : in out; start : Shape from TopoDS; amess : CString)
68 is static;
69 ---Purpose : Records a new Warning message
70
71 AddFail (me : in out; start : Transient from Standard; amess : CString)
72 is static;
73 ---Purpose : Records a new Fail message
74
75 AddWarning (me : in out; start : Transient from Standard; amess : CString)
76 is static;
77 ---Purpose : Records a new Warning message
78
79 HasShapeResult (me ; start : Shape from TopoDS)
80 returns Boolean;
81 ---Purpose : Returns True if start was already treated and has a result in "TheMap"
82 -- else returns False.
83
84 GetShapeResult (me ; start : Shape from TopoDS)
85 returns Transient from Standard;
86 ---Purpose : Returns the result of the transfer of the Shape "start" contained
87 -- in "TheMap" . (if HasShapeResult is True).
88
89 SetShapeResult (me : in out;
90 start : Shape from TopoDS;
91 result : Transient from Standard);
92 ---Purpose : set in "TheMap" the result of the transfer of the Shape "start".
93
94
95 HasShapeResult (me ; start : Transient from Standard)
96 returns Boolean;
97 ---Purpose : Returns True if start was already treated and has a result in "TheMap"
98 -- else returns False.
99
100 GetShapeResult (me ; start : Transient from Standard)
101 returns Transient from Standard;
102 ---Purpose : Returns the result of the transfer of the Transient "start" contained
103 -- in "TheMap" . (if HasShapeResult is True).
104
105 SetShapeResult (me : in out;
106 start : Transient from Standard;
107 result : Transient from Standard);
108 ---Purpose : set in "TheMap" the result of the transfer of the Transient "start".
109
110 GetConvertSurfaceMode (me) returns Boolean;
111 ---Purpose: Returns mode for conversion of surfaces
112 -- (value of parameter write.convertsurface.mode)
113
114 GetPCurveMode (me) returns Boolean;
115 ---Purpose: Returns mode for writing pcurves
116 -- (value of parameter write.surfacecurve.mode)
117
118 Delete (me:out) is virtual;
119 ---C++: alias "Standard_EXPORT virtual ~BRepToIGES_BREntity() { Delete(); }"
120
121fields
122
123 TheModel : IGESModel from IGESData ;
124
125 TheUnitFactor : Real from Standard;
126
127 myConvSurface : Boolean;
128 myPCurveMode : Boolean;
129
130 TheMap : FinderProcess from Transfer;
131
132end BREntity;