Salome HOME
Fix Redesign of SMESH documentation
[modules/smesh.git] / src / SMESHDS / SMESHDS_SubMesh.hxx
1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 //  SMESH SMESHDS : management of mesh data and SMESH document
24 //  File   : SMESHDS_SubMesh.hxx
25 //  Module : SMESH
26 //
27 #ifndef _SMESHDS_SubMesh_HeaderFile
28 #define _SMESHDS_SubMesh_HeaderFile
29
30 #include "SMESH_SMESHDS.hxx"
31
32 #include "SMDS_Mesh.hxx"
33 #include <vector>
34
35 #include <boost/container/flat_set.hpp>
36 class SMESHDS_SubMesh;
37 typedef boost::container::flat_set< const SMESHDS_SubMesh* > TSubMeshSet;
38
39 class SMESHDS_SubMesh;
40 typedef SMDS_Iterator<const SMESHDS_SubMesh*> SMESHDS_SubMeshIterator;
41 typedef boost::shared_ptr< SMESHDS_SubMeshIterator > SMESHDS_SubMeshIteratorPtr;
42
43 class SMESHDS_Mesh;
44
45 class SMESHDS_EXPORT SMESHDS_SubMesh
46 {
47  public:
48   SMESHDS_SubMesh(SMESHDS_Mesh *parent, int index);
49   virtual ~SMESHDS_SubMesh();
50
51   virtual bool IsComplexSubmesh() const { return !mySubMeshes.empty(); }
52
53   // if !IsComplexSubmesh()
54   virtual void AddElement(const SMDS_MeshElement * ME);
55   virtual bool RemoveElement(const SMDS_MeshElement * ME); // ret true if ME was in
56   virtual void AddNode(const SMDS_MeshNode * ME);
57   virtual bool RemoveNode(const SMDS_MeshNode * ME);       // ret true if ME was in
58   //virtual const SMDS_MeshElement* GetElement( size_t idInShape ) const;
59   //virtual const SMDS_MeshNode*    GetNode   ( size_t idInShape ) const;
60
61   // if IsComplexSubmesh()
62   void AddSubMesh( const SMESHDS_SubMesh* theSubMesh );
63   bool RemoveSubMesh( const SMESHDS_SubMesh* theSubMesh );
64   void RemoveAllSubmeshes();
65   bool ContainsSubMesh( const SMESHDS_SubMesh* theSubMesh ) const;
66   int  NbSubMeshes() const { return mySubMeshes.size(); }
67   SMESHDS_SubMeshIteratorPtr GetSubMeshIterator() const;
68
69   // for both types
70   virtual int NbElements() const;
71   virtual int NbNodes() const;
72   virtual SMDS_ElemIteratorPtr GetElements() const;
73   virtual SMDS_NodeIteratorPtr GetNodes() const;
74   virtual bool Contains(const SMDS_MeshElement * ME) const;      // check if elem or node is in
75   virtual bool IsQuadratic() const;
76
77   // clear the contents
78   virtual void Clear();
79
80   SMESHDS_Mesh* GetParent() const { return const_cast< SMESHDS_Mesh*>( myParent ); }
81   int           GetID()     const { return myIndex; }
82
83  private:
84
85   int             myIndex;
86   int             myNbElements;
87   int             myNbNodes;
88   SMESHDS_Mesh *  myParent;
89   TSubMeshSet     mySubMeshes;
90
91 };
92 #endif