[occt.git] / src / BRepToIGESBRep / BRepToIGESBRep_Entity.cdl

-- Created on: 1995-04-25
-- Created by: Marie Jose MARTZ
-- Copyright (c) 1995-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.


class Entity from BRepToIGESBRep inherits BREntity from BRepToIGES


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

uses

    Geometry                 from Geom,
    Shape                    from TopoDS,
    Vertex                   from TopoDS,
    Edge                     from TopoDS,
    Wire                     from TopoDS,
    Face                     from TopoDS,
    Shell                    from TopoDS,
    Solid                    from TopoDS,
    CompSolid	             from TopoDS,
    Compound                 from TopoDS,
    IndexedMapOfShape        from TopTools,
    IndexedMapOfTransient    from TColStd,
    IGESEntity               from IGESData,
    IGESModel                from IGESData,
    VertexList               from IGESSolid,
    EdgeList                 from IGESSolid,
    Loop                     from IGESSolid,
    Face                     from IGESSolid,   
    Shell                    from IGESSolid, 
    ManifoldSolid            from IGESSolid,
    CString                  from Standard,
    FinderProcess            from Transfer

is

    Create 
    	returns Entity from BRepToIGESBRep;
    ---Purpose : Creates a tool Entity


    Clear              (me        : in out);
    ---Purpose : Clears the contents of the fields


    TransferVertexList (me        : in out);
    ---Purpose :  Create the VertexList entity 


    IndexVertex        (me; 
                        myvertex    : Vertex from TopoDS) 
    returns Integer
    ---Purpose: Returns the index of <myvertex> in "myVertices"
    is static;


    AddVertex          (me        : in out; 
                        myvertex  : Vertex from TopoDS) 
    returns Integer
    ---Purpose: Stores <myvertex> in "myVertices"
    --          Returns the index of <myvertex>.
    is static;
	

    TransferEdgeList   (me        : in out);
    ---Purpose :  Transfert an Edge entity from TopoDS to IGES


    IndexEdge          (me; 
                        myedge    : Edge from TopoDS) 
    returns Integer
    ---Purpose: Returns the index of <myedge> in "myEdges"
    is static;


    AddEdge            (me        : in out; 
                        myedge    : Edge from TopoDS;
			mycurve3d : IGESEntity from IGESData)
    returns Integer
    ---Purpose: Stores <myedge> in "myEdges" and <mycurve3d> in "myCurves".
    --           Returns the index of <myedge>.
    is static;
	

    TransferShape      (me : in out; start : Shape from TopoDS)
    returns IGESEntity from IGESData is redefined;
    ---Purpose : Returns the result of the transfert of any Shape
    --           If  the transfer has  failed, this member return a NullEntity.
	

    TransferEdge       (me        : in out;
                        myedge    : Edge     from TopoDS)
    returns mutable IGESEntity from IGESData;
    ---Purpose :  Transfert an Edge entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferEdge       (me        : in out;
                        myedge    : Edge     from TopoDS;
		        myface    : Face     from TopoDS;
                        length    : in Real   from Standard)		    				    
    returns mutable IGESEntity from IGESData;
    ---Purpose :  Transfert an Edge entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferWire       (me        : in out;
                        mywire    : Wire     from TopoDS;
		        myface    : Face     from TopoDS;
			length    : in Real   from Standard)		    
    returns mutable Loop from IGESSolid;
    ---Purpose :  Transfert a Wire entity from TopoDS to IGES.
    --            Returns the curve associated to mywire in the parametric space of myface.
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferFace       (me    : in out;
                        start : Face from TopoDS)
    returns mutable Face from IGESSolid;
    ---Purpose :  Transfert a Face entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferShell      (me    : in out;
                        start : Shell from TopoDS)
    returns mutable Shell from IGESSolid;
    ---Purpose :  Transfert an Shell entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferSolid      (me    : in out;
                        start : Solid from TopoDS)
    	 returns mutable ManifoldSolid from IGESSolid;
    ---Purpose :  Transfert a Solid entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferCompSolid  (me    : in out;
                        start : CompSolid from TopoDS)
    	 returns mutable IGESEntity from IGESData;
    ---Purpose :  Transfert an CompSolid entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferCompound   (me    : in out;
                        start : Compound from TopoDS)
    	 returns mutable IGESEntity from IGESData;
    ---Purpose :  Transfert a Compound entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.

fields

    myVertices    : IndexedMapOfShape from TopTools;
    myEdges       : IndexedMapOfShape from TopTools;
    myCurves      : IndexedMapOfTransient from TColStd;
    myEdgeList    : EdgeList from IGESSolid;
    myVertexList  : VertexList from IGESSolid;
    
    
end Entity;
Commit	Line	Data
b311480e	1	-- Created on: 1995-04-25
	2	-- Created by: Marie Jose MARTZ
	3	-- Copyright (c) 1995-1999 Matra Datavision
	4	-- Copyright (c) 1999-2012 OPEN CASCADE SAS
	5	--
	6	-- The content of this file is subject to the Open CASCADE Technology Public
	7	-- License Version 6.5 (the "License"). You may not use the content of this file
	8	-- except in compliance with the License. Please obtain a copy of the License
	9	-- at http://www.opencascade.org and read it completely before using this file.
	10	--
	11	-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
	12	-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
	13	--
	14	-- The Original Code and all software distributed under the License is
	15	-- distributed on an "AS IS" basis, without warranty of any kind, and the
	16	-- Initial Developer hereby disclaims all such warranties, including without
	17	-- limitation, any warranties of merchantability, fitness for a particular
	18	-- purpose or non-infringement. Please see the License for the specific terms
	19	-- and conditions governing the rights and limitations under the License.
	20
7fd59977	21
	22	class Entity from BRepToIGESBRep inherits BREntity from BRepToIGES
	23
	24
	25	---Purpose : provides methods to transfer BRep entity from CASCADE to IGESBRep.
	26
	27	uses
	28
	29	Geometry from Geom,
	30	Shape from TopoDS,
	31	Vertex from TopoDS,
	32	Edge from TopoDS,
	33	Wire from TopoDS,
	34	Face from TopoDS,
	35	Shell from TopoDS,
	36	Solid from TopoDS,
	37	CompSolid from TopoDS,
	38	Compound from TopoDS,
	39	IndexedMapOfShape from TopTools,
	40	IndexedMapOfTransient from TColStd,
	41	IGESEntity from IGESData,
	42	IGESModel from IGESData,
	43	VertexList from IGESSolid,
	44	EdgeList from IGESSolid,
	45	Loop from IGESSolid,
	46	Face from IGESSolid,
	47	Shell from IGESSolid,
	48	ManifoldSolid from IGESSolid,
	49	CString from Standard,
	50	FinderProcess from Transfer
	51
	52	is
	53
	54	Create
	55	returns Entity from BRepToIGESBRep;
	56	---Purpose : Creates a tool Entity
	57
	58
	59	Clear (me : in out);
	60	---Purpose : Clears the contents of the fields
	61
	62
	63	TransferVertexList (me : in out);
	64	---Purpose : Create the VertexList entity
	65
	66
	67	IndexVertex (me;
	68	myvertex : Vertex from TopoDS)
	69	returns Integer
	70	---Purpose: Returns the index of <myvertex> in "myVertices"
	71	is static;
	72
	73
	74	AddVertex (me : in out;
	75	myvertex : Vertex from TopoDS)
	76	returns Integer
	77	---Purpose: Stores <myvertex> in "myVertices"
	78	-- Returns the index of <myvertex>.
	79	is static;
	80
	81
	82	TransferEdgeList (me : in out);
	83	---Purpose : Transfert an Edge entity from TopoDS to IGES
	84
85
86	IndexEdge (me;
87	myedge : Edge from TopoDS)
88	returns Integer
89	---Purpose: Returns the index of <myedge> in "myEdges"
90	is static;
91
92
93	AddEdge (me : in out;
94	myedge : Edge from TopoDS;
95	mycurve3d : IGESEntity from IGESData)
96	returns Integer
97	---Purpose: Stores <myedge> in "myEdges" and <mycurve3d> in "myCurves".
98	-- Returns the index of <myedge>.
99	is static;
100
101
102	TransferShape (me : in out; start : Shape from TopoDS)
103	returns IGESEntity from IGESData is redefined;
104	---Purpose : Returns the result of the transfert of any Shape
105	-- If the transfer has failed, this member return a NullEntity.
106
107
108	TransferEdge (me : in out;
109	myedge : Edge from TopoDS)
110	returns mutable IGESEntity from IGESData;
111	---Purpose : Transfert an Edge entity from TopoDS to IGES
112	-- If this Entity could not be converted, this member returns a NullEntity.
113
114
115	TransferEdge (me : in out;
116	myedge : Edge from TopoDS;
117	myface : Face from TopoDS;
118	length : in Real from Standard)
119	returns mutable IGESEntity from IGESData;
120	---Purpose : Transfert an Edge entity from TopoDS to IGES
121	-- If this Entity could not be converted, this member returns a NullEntity.
122
123
124	TransferWire (me : in out;
125	mywire : Wire from TopoDS;
126	myface : Face from TopoDS;
127	length : in Real from Standard)
128	returns mutable Loop from IGESSolid;
129	---Purpose : Transfert a Wire entity from TopoDS to IGES.
130	-- Returns the curve associated to mywire in the parametric space of myface.
131	-- If this Entity could not be converted, this member returns a NullEntity.
132
133
134	TransferFace (me : in out;
135	start : Face from TopoDS)
136	returns mutable Face from IGESSolid;
137	---Purpose : Transfert a Face entity from TopoDS to IGES
138	-- If this Entity could not be converted, this member returns a NullEntity.
139
140
141	TransferShell (me : in out;
142	start : Shell from TopoDS)
143	returns mutable Shell from IGESSolid;
144	---Purpose : Transfert an Shell entity from TopoDS to IGES
145	-- If this Entity could not be converted, this member returns a NullEntity.
146
147
148	TransferSolid (me : in out;
149	start : Solid from TopoDS)
150	returns mutable ManifoldSolid from IGESSolid;
151	---Purpose : Transfert a Solid entity from TopoDS to IGES
152	-- If this Entity could not be converted, this member returns a NullEntity.
153
154
155	TransferCompSolid (me : in out;
156	start : CompSolid from TopoDS)
157	returns mutable IGESEntity from IGESData;
158	---Purpose : Transfert an CompSolid entity from TopoDS to IGES
159	-- If this Entity could not be converted, this member returns a NullEntity.
160
161
162	TransferCompound (me : in out;
163	start : Compound from TopoDS)
164	returns mutable IGESEntity from IGESData;
165	---Purpose : Transfert a Compound entity from TopoDS to IGES
166	-- If this Entity could not be converted, this member returns a NullEntity.
167
168	fields
169
170	myVertices : IndexedMapOfShape from TopTools;
171	myEdges : IndexedMapOfShape from TopTools;
172	myCurves : IndexedMapOfTransient from TColStd;
173	myEdgeList : EdgeList from IGESSolid;
174	myVertexList : VertexList from IGESSolid;
175
176
177	end Entity;
178