Salome HOME
Merge from V6_5_BR 05/06/2012
[modules/smesh.git] / src / SMESHUtils / SMESH_TypeDefs.hxx
1 // Copyright (C) 2007-2012  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.
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 // File      : SMESH_TypeDefs.hxx
23 // Created   : Thu Jan 27 18:38:33 2011
24 // Author    : Edward AGAPOV (eap)
25
26
27 #ifndef __SMESH_TypeDefs_HXX__
28 #define __SMESH_TypeDefs_HXX__
29
30 #include "SMESH_Utils.hxx"
31
32 #include <SMDS_MeshNode.hxx>
33
34 #include <gp_XYZ.hxx>
35
36 #include <map>
37 #include <list>
38 #include <set>
39 #include <cassert>
40
41 typedef std::map<const SMDS_MeshElement*,
42                  std::list<const SMDS_MeshElement*> >        TElemOfElemListMap;
43 typedef std::map<const SMDS_MeshNode*, const SMDS_MeshNode*> TNodeNodeMap;
44
45 //!< Set of elements sorted by ID, to be used to assure predictability of edition
46 typedef std::set< const SMDS_MeshElement*, TIDCompare >      TIDSortedElemSet;
47 typedef std::set< const SMDS_MeshNode*,    TIDCompare >      TIDSortedNodeSet;
48
49 typedef std::pair< const SMDS_MeshNode*, const SMDS_MeshNode* >   NLink;
50
51
52 namespace SMESHUtils
53 {
54   /*!
55    * \brief Enforce freeing memory allocated by std::vector
56    */
57   template <class TVECTOR>
58   void FreeVector(TVECTOR& vec)
59   {
60     TVECTOR v2;
61     vec.swap( v2 );
62   }
63 }
64
65 //=======================================================================
66 /*!
67  * \brief A sorted pair of nodes
68  */
69 //=======================================================================
70
71 struct SMESH_TLink: public NLink
72 {
73   SMESH_TLink(const SMDS_MeshNode* n1, const SMDS_MeshNode* n2 ):NLink( n1, n2 )
74   { if ( n1->GetID() < n2->GetID() ) std::swap( first, second ); }
75   SMESH_TLink(const NLink& link ):NLink( link )
76   { if ( first->GetID() < second->GetID() ) std::swap( first, second ); }
77   const SMDS_MeshNode* node1() const { return first; }
78   const SMDS_MeshNode* node2() const { return second; }
79 };
80
81 //=======================================================================
82 /*!
83  * \brief SMESH_TLink knowing its orientation
84  */
85 //=======================================================================
86
87 struct SMESH_OrientedLink: public SMESH_TLink
88 {
89   bool _reversed;
90   SMESH_OrientedLink(const SMDS_MeshNode* n1, const SMDS_MeshNode* n2 )
91     : SMESH_TLink( n1, n2 ), _reversed( n1 != node1() ) {}
92 };
93
94 //------------------------------------------
95 /*!
96  * \brief SMDS_MeshNode -> gp_XYZ convertor
97  */
98 //------------------------------------------
99 struct SMESH_TNodeXYZ : public gp_XYZ
100 {
101   const SMDS_MeshNode* _node;
102   SMESH_TNodeXYZ( const SMDS_MeshElement* e):gp_XYZ(0,0,0),_node(0) {
103     if (e) {
104       assert( e->GetType() == SMDSAbs_Node );
105       _node = static_cast<const SMDS_MeshNode*>(e);
106       double xyz[3];
107       _node->GetXYZ(xyz); // - thread safe gatting coords
108       SetCoord( xyz[0], xyz[1], xyz[2] );
109     }
110   }
111   double Distance(const SMDS_MeshNode* n)       const { return (SMESH_TNodeXYZ( n )-*this).Modulus(); }
112   double SquareDistance(const SMDS_MeshNode* n) const { return (SMESH_TNodeXYZ( n )-*this).SquareModulus(); }
113   bool operator==(const SMESH_TNodeXYZ& other) const { return _node == other._node; }
114 };
115
116 // --------------------------------------------------------------------------------
117 // class SMESH_SequenceOfElemPtr
118 #include <NCollection_DefineSequence.hxx>
119
120 class SMDS_MeshElement;
121
122 typedef const SMDS_MeshElement* SMDS_MeshElementPtr;
123
124 DEFINE_BASECOLLECTION (SMESH_BaseCollectionElemPtr, SMDS_MeshElementPtr)
125 DEFINE_SEQUENCE (SMESH_SequenceOfElemPtr, SMESH_BaseCollectionElemPtr, SMDS_MeshElementPtr)
126
127
128 // --------------------------------------------------------------------------------
129 // class SMESH_SequenceOfNode
130 typedef const SMDS_MeshNode* SMDS_MeshNodePtr;
131
132 DEFINE_BASECOLLECTION (SMESH_BaseCollectionNodePtr, SMDS_MeshNodePtr)
133 DEFINE_SEQUENCE(SMESH_SequenceOfNode,
134                 SMESH_BaseCollectionNodePtr, SMDS_MeshNodePtr)
135
136 // --------------------------------------------------------------------------------
137 // #include "SMESHDS_DataMapOfShape.hxx"
138
139 // #include <NCollection_DefineIndexedMap.hxx>
140
141 // #include <TopoDS_Shape.hxx>
142
143 ///  Class SMESH_IndexedMapOfShape
144
145 // DEFINE_BASECOLLECTION (SMESH_BaseCollectionShape, TopoDS_Shape)
146 // DEFINE_INDEXEDMAP (SMESH_IndexedMapOfShape, SMESH_BaseCollectionShape, TopoDS_Shape)
147
148 ///  Class SMESH_IndexedDataMapOfShapeIndexedMapOfShape
149
150 // DEFINE_BASECOLLECTION (SMESH_BaseCollectionIndexedMapOfShape, SMESH_IndexedMapOfShape)
151 // DEFINE_INDEXEDDATAMAP (SMESH_IndexedDataMapOfShapeIndexedMapOfShape,
152 //                        SMESH_BaseCollectionIndexedMapOfShape, TopoDS_Shape,
153 //                        SMESH_IndexedMapOfShape)
154
155 // --------------------------------------------------------------------------------
156 // class SMESH_DataMapOfElemPtrSequenceOfElemPtr
157
158 // SMESHUtils_EXPORT 
159 // inline Standard_Integer HashCode(SMDS_MeshElementPtr theElem,
160 //                                  const Standard_Integer theUpper)
161 // {
162 //   void* anElem = (void*) theElem;
163 //   return HashCode(anElem,theUpper);
164 // }
165
166 // SMESHUtils_EXPORT 
167 // inline Standard_Boolean IsEqual(SMDS_MeshElementPtr theOne,
168 //                                 SMDS_MeshElementPtr theTwo)
169 // {
170 //   return theOne == theTwo;
171 // }
172
173 // DEFINE_BASECOLLECTION (SMESH_BaseCollectionSequenceOfElemPtr, SMESH_SequenceOfElemPtr)
174 // DEFINE_DATAMAP (SMESH_DataMapOfElemPtrSequenceOfElemPtr,
175 //                 SMESH_BaseCollectionSequenceOfElemPtr,
176 //                 SMDS_MeshElementPtr, SMESH_SequenceOfElemPtr)
177
178 #endif