[occt.git] / src / BRepToIGES / BRepToIGES_BREntity.cdl

-- File:	BRepToIGES_BREntity.cdl
-- Created:	Tue Nov 15 17:07:36 1994
-- Author:	Marie Jose MARTZ
--		<mjm@minox>
---Copyright:	 Matra Datavision 1994


class BREntity from BRepToIGES


    ---Purpose : provides methods to transfer BRep entity from CASCADE to IGES.

uses
    Geometry                 from Geom,
    Shape                    from TopoDS,
    IGESEntity               from IGESData,
    IGESModel                from IGESData,
    FinderProcess            from Transfer

is

    Create 
    	returns BREntity from BRepToIGES;
    ---Purpose : Creates a tool BREntity

    Init(me : in out);
    ---Purpose : Initializes the field of the tool BREntity with 
    --        default creating values. 

    SetModel(me : in out; model : IGESModel from IGESData);
    ---Purpose : Set the value of "TheModel"

    GetModel(me) 
    	returns IGESModel from IGESData;
    ---Purpose : Returns the value of "TheModel"

    GetUnit(me)
    	returns Real from Standard;
    ---Purpose : Returns the value of the UnitFlag of the header of the model
    --           in meters.

    SetTransferProcess(me : in out; TP : FinderProcess from Transfer);
    ---Purpose : Set the value of "TheMap"
    
    GetTransferProcess(me) 
    	returns FinderProcess from Transfer;
    ---Purpose : Returns the value of "TheMap"

    TransferShape(me : in out; start : Shape from TopoDS)
    	returns IGESEntity from IGESData is virtual;
    ---Purpose : Returns the result of the transfert of any Shape
    --           If  the transfer has  failed, this member return a NullEntity.
	
    AddFail (me : in out; start : Shape from TopoDS; amess : CString)  
    	is static;
    ---Purpose : Records a new Fail message

    AddWarning (me : in out; start : Shape from TopoDS; amess : CString)  
    	is static;
    ---Purpose : Records a new Warning message

    AddFail (me : in out; start : Transient from Standard; amess : CString)  
    	is static;
    ---Purpose : Records a new Fail message

    AddWarning (me : in out; start : Transient from Standard; amess : CString)  
    	is static;
    ---Purpose : Records a new Warning message

    HasShapeResult (me ; start : Shape from TopoDS)
    	returns Boolean;
    ---Purpose : Returns True if start was already treated and has a result in "TheMap"    
    --           else returns False.
    
    GetShapeResult (me ; start : Shape from TopoDS)
    	returns Transient from Standard;
    ---Purpose : Returns the result of the transfer of the Shape "start" contained
    --           in "TheMap" . (if HasShapeResult is True).	
	
    SetShapeResult (me     : in out; 
                    start  : Shape from TopoDS;
                    result : Transient from Standard); 
    ---Purpose : set in "TheMap" the result of the transfer of the Shape "start".
	

    HasShapeResult (me ; start : Transient from Standard)
    	returns Boolean;
    ---Purpose : Returns True if start was already treated and has a result in "TheMap"    
    --           else returns False.
    
    GetShapeResult (me ; start : Transient from Standard)
    	returns Transient from Standard;
    ---Purpose : Returns the result of the transfer of the Transient "start" contained
    --           in "TheMap" . (if HasShapeResult is True).	
	
    SetShapeResult (me     : in out;
    	    	    start  : Transient from Standard; 
                    result : Transient from Standard); 
    ---Purpose : set in "TheMap" the result of the transfer of the Transient "start".
	
    GetConvertSurfaceMode (me) returns Boolean;
    	---Purpose: Returns mode for conversion of surfaces
	--          (value of parameter write.convertsurface.mode)
	    
    GetPCurveMode (me) returns Boolean;
    	---Purpose: Returns mode for writing pcurves
	--          (value of parameter write.surfacecurve.mode)
    
    Delete (me:out) is virtual; 
    	---C++: alias "Standard_EXPORT virtual ~BRepToIGES_BREntity() { Delete(); }" 	    

fields

    TheModel      : IGESModel from IGESData ;
	
    TheUnitFactor : Real from Standard;

    myConvSurface : Boolean;
    myPCurveMode  : Boolean;

    TheMap        : FinderProcess from Transfer;

end BREntity;
Commit	Line	Data
7fd59977	1	-- File: BRepToIGES_BREntity.cdl
	2	-- Created: Tue Nov 15 17:07:36 1994
	3	-- Author: Marie Jose MARTZ
	4	-- <mjm@minox>
	5	---Copyright: Matra Datavision 1994
	6
	7
	8	class BREntity from BRepToIGES
	9
	10
	11	---Purpose : provides methods to transfer BRep entity from CASCADE to IGES.
	12
	13	uses
	14	Geometry from Geom,
	15	Shape from TopoDS,
	16	IGESEntity from IGESData,
	17	IGESModel from IGESData,
	18	FinderProcess from Transfer
	19
	20	is
	21
	22	Create
	23	returns BREntity from BRepToIGES;
	24	---Purpose : Creates a tool BREntity
	25
	26	Init(me : in out);
	27	---Purpose : Initializes the field of the tool BREntity with
	28	-- default creating values.
	29
	30	SetModel(me : in out; model : IGESModel from IGESData);
	31	---Purpose : Set the value of "TheModel"
	32
	33	GetModel(me)
	34	returns IGESModel from IGESData;
	35	---Purpose : Returns the value of "TheModel"
	36
	37	GetUnit(me)
	38	returns Real from Standard;
	39	---Purpose : Returns the value of the UnitFlag of the header of the model
	40	-- in meters.
	41
	42	SetTransferProcess(me : in out; TP : FinderProcess from Transfer);
	43	---Purpose : Set the value of "TheMap"
	44
	45	GetTransferProcess(me)
	46	returns FinderProcess from Transfer;
	47	---Purpose : Returns the value of "TheMap"
	48
	49	TransferShape(me : in out; start : Shape from TopoDS)
	50	returns IGESEntity from IGESData is virtual;
	51	---Purpose : Returns the result of the transfert of any Shape
	52	-- If the transfer has failed, this member return a NullEntity.
	53
	54	AddFail (me : in out; start : Shape from TopoDS; amess : CString)
	55	is static;
	56	---Purpose : Records a new Fail message
	57
	58	AddWarning (me : in out; start : Shape from TopoDS; amess : CString)
	59	is static;
	60	---Purpose : Records a new Warning message
	61
	62	AddFail (me : in out; start : Transient from Standard; amess : CString)
	63	is static;
	64	---Purpose : Records a new Fail message
65
66	AddWarning (me : in out; start : Transient from Standard; amess : CString)
67	is static;
68	---Purpose : Records a new Warning message
69
70	HasShapeResult (me ; start : Shape from TopoDS)
71	returns Boolean;
72	---Purpose : Returns True if start was already treated and has a result in "TheMap"
73	-- else returns False.
74
75	GetShapeResult (me ; start : Shape from TopoDS)
76	returns Transient from Standard;
77	---Purpose : Returns the result of the transfer of the Shape "start" contained
78	-- in "TheMap" . (if HasShapeResult is True).
79
80	SetShapeResult (me : in out;
81	start : Shape from TopoDS;
82	result : Transient from Standard);
83	---Purpose : set in "TheMap" the result of the transfer of the Shape "start".
84
85
86	HasShapeResult (me ; start : Transient from Standard)
87	returns Boolean;
88	---Purpose : Returns True if start was already treated and has a result in "TheMap"
89	-- else returns False.
90
91	GetShapeResult (me ; start : Transient from Standard)
92	returns Transient from Standard;
93	---Purpose : Returns the result of the transfer of the Transient "start" contained
94	-- in "TheMap" . (if HasShapeResult is True).
95
96	SetShapeResult (me : in out;
97	start : Transient from Standard;
98	result : Transient from Standard);
99	---Purpose : set in "TheMap" the result of the transfer of the Transient "start".
100
101	GetConvertSurfaceMode (me) returns Boolean;
102	---Purpose: Returns mode for conversion of surfaces
103	-- (value of parameter write.convertsurface.mode)
104
105	GetPCurveMode (me) returns Boolean;
106	---Purpose: Returns mode for writing pcurves
107	-- (value of parameter write.surfacecurve.mode)
108
109	Delete (me:out) is virtual;
110	---C++: alias "Standard_EXPORT virtual ~BRepToIGES_BREntity() { Delete(); }"
111
112	fields
113
114	TheModel : IGESModel from IGESData ;
115
116	TheUnitFactor : Real from Standard;
117
118	myConvSurface : Boolean;
119	myPCurveMode : Boolean;
120
121	TheMap : FinderProcess from Transfer;
122
123	end BREntity;