smesh/src/SMESHDS/SMESHDS_Mesh.cdl

--  SMESH SMESHDS : management of mesh data and SMESH document
--
--  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
--  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
-- 
--  This library is free software; you can redistribute it and/or 
--  modify it under the terms of the GNU Lesser General Public 
--  License as published by the Free Software Foundation; either 
--  version 2.1 of the License. 
-- 
--  This library is distributed in the hope that it will be useful, 
--  but WITHOUT ANY WARRANTY; without even the implied warranty of 
--  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
--  Lesser General Public License for more details. 
-- 
--  You should have received a copy of the GNU Lesser General Public 
--  License along with this library; if not, write to the Free Software 
--  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
-- 
--  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
--
--
--
--  File   : SMESHDS_Mesh.cdl
--  Author : Yves FRICAUD, OCC
--  Module : SMESH

class Mesh from SMESHDS inherits Mesh from SMDS

uses 
	Mesh                              from SMDS,
	MeshNode	                  from SMDS,	
	MeshEdge                          from SMDS,	
	MeshFace                          from SMDS,	
	MeshElement                       from SMDS,	
	Shell                             from TopoDS,
	Shape                             from TopoDS,
	Face                              from TopoDS,
	Edge                              from TopoDS,
	Vertex                            from TopoDS,
	SubMesh	                          from SMESHDS,
	PtrHypothesis                     from SMESHDS,
	ListOfPtrHypothesis               from SMESHDS,
	Script                            from SMESHDS,
	IndexedMapOfShape                 from TopTools,
	DataMapOfIntegerSubMesh           from SMESHDS,
	DataMapOfShapeListOfPtrHypothesis from SMESHDS

	
is

	Create (MeshID : Integer from Standard) returns mutable Mesh from SMESHDS;
	
-- Building

	ShapeToMesh (me: mutable; S : Shape from TopoDS);

   	AddHypothesis(me: mutable; SS : in Shape from TopoDS; H : PtrHypothesis from SMESHDS)
	returns Boolean;	

   	RemoveHypothesis(me: mutable; S : in Shape from TopoDS; H : PtrHypothesis from SMESHDS)
	returns Boolean;	

	
	-- Building Node
	
	AddNode(me: mutable; x,y,z : Real) returns Integer from Standard
	is redefined;

	RemoveNode (me: mutable; ID: Integer) is redefined;
	
	MoveNode (me: mutable; ID: Integer; x,y,z: Real);
  	
	
	-- Building Edge
    	AddEdge(me: mutable; idnode1, idnode2 : Integer) returns Integer from Standard
	is redefined;

	-- Building Face
    	AddFace(me: mutable; idnode1, idnode2, idnode3 : Integer) returns Integer from Standard
	-- To build a Triangle
	is redefined;


    	AddFace(me: mutable; idnode1, idnode2, idnode3 , idnode4 : Integer) returns Integer from Standard
	-- To build a quadrangle
	is redefined;

	-- Building Volume
	
	AddVolume(me: mutable; idnode1, idnode2, idnode3, idnode4 : Integer) returns Integer
	-- To build a Tetrahedron
	is redefined;

	AddVolume(me: mutable; idnode1, idnode2, idnode3, idnode4, idnode5 : Integer) returns Integer
	-- To build a Pyramid
	is redefined;

	AddVolume(me: mutable; idnode1, idnode2, idnode3, idnode4, idnode5, idnode6 : Integer) returns Integer
	-- To build a Prism
	is redefined;

	AddVolume(me: mutable; idnode1, idnode2, idnode3, idnode4, idnode5, idnode6, idnode7, idnode8 : Integer) returns Integer
	-- To build a Hexahedron
	is redefined;


        RemoveElement(me: mutable; IDelem : Integer)
	is redefined;

	-- Binding  BRep and MeshElements

	SetNodeInVolume (me: mutable; aNode : MeshNode from SMDS ; S : Shell  from TopoDS);

	SetNodeOnFace  (me: mutable; aNode : MeshNode from SMDS ; S : Face  from TopoDS);

	SetNodeOnEdge  (me: mutable; aNode : MeshNode from SMDS ; S : Edge   from TopoDS);

	SetNodeOnVertex(me: mutable; aNode : MeshNode from SMDS ; S : Vertex from TopoDS);

	UnSetNodeOnShape (me: mutable; aNode : MeshNode from SMDS);

	SetMeshElementOnShape (me: mutable; anElt : MeshElement from SMDS ; S : Shape from TopoDS);

	UnSetMeshElementOnShape (me: mutable; anElt : MeshElement from SMDS ; S : Shape from TopoDS) ;

-- Exploration 

	ShapeToMesh (me: mutable) returns Shape from TopoDS;

	HasMeshElements (me: mutable; S : Shape from TopoDS)  returns Boolean from Standard;

	MeshElements (me: mutable; S : Shape from TopoDS)  returns SubMesh from SMESHDS;

	HasHypothesis (me: mutable; S : Shape from TopoDS)  returns Boolean from Standard;

	GetHypothesis (me: mutable; S : Shape from TopoDS) 
	---C++ : return const &	
	returns ListOfPtrHypothesis from SMESHDS;	

-- Historic of commands
	
	GetScript(me: mutable) returns Script from SMESHDS;
	---C++ : return const &


	ClearScript(me: mutable);

-- Methods for persitance

	ShapeToIndex (me : mutable; aShape : Shape from TopoDS) returns Integer from Standard;

	IndexToShape (me : mutable; ShapeIndex : Integer from Standard) returns Shape from TopoDS;

	NewSubMesh (me : mutable; Index : Integer from Standard);

	SetNodeInVolume (me: mutable; aNode : MeshNode from SMDS ; Index : Integer from Standard);

	SetNodeOnFace  (me: mutable; aNode : MeshNode from SMDS ;  Index : Integer from Standard);

	SetNodeOnEdge  (me: mutable; aNode : MeshNode from SMDS ;  Index : Integer from Standard);

	SetNodeOnVertex(me: mutable; aNode : MeshNode from SMDS ;  Index : Integer from Standard);

	SetMeshElementOnShape (me: mutable; anElt : MeshElement from SMDS ; Index : Integer from Standard);


fields

	myMeshID              : Integer                           from Standard;	
	myShape               : Shape                             from TopoDS;
	myIndexToShape        : IndexedMapOfShape                 from TopTools; -- Gives Index from Shape and Shape from Index
	myShapeIndexToSubMesh : DataMapOfIntegerSubMesh           from SMESHDS ;
	myShapeToHypothesis   : DataMapOfShapeListOfPtrHypothesis from SMESHDS; 
	myScript              : Script                            from SMESHDS;

end Mesh;