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   template <class TVECTOR>
  64   void CompactVector(TVECTOR& vec)
  65   {
  66     TVECTOR v2( vec );
  67     vec.swap( v2 );
  68   }
  69 }
  70
  71 //=======================================================================
  72 /*!
  73  * \brief A sorted pair of nodes
  74  */
  75 //=======================================================================
  76
  77 struct SMESH_TLink: public NLink
  78 {
  79   SMESH_TLink(const SMDS_MeshNode* n1, const SMDS_MeshNode* n2 ):NLink( n1, n2 )
  80   { if ( n1->GetID() < n2->GetID() ) std::swap( first, second ); }
  81   SMESH_TLink(const NLink& link ):NLink( link )
  82   { if ( first->GetID() < second->GetID() ) std::swap( first, second ); }
  83   const SMDS_MeshNode* node1() const { return first; }
  84   const SMDS_MeshNode* node2() const { return second; }
  85 };
  86
  87 //=======================================================================
  88 /*!
  89  * \brief SMESH_TLink knowing its orientation
  90  */
  91 //=======================================================================
  92
  93 struct SMESH_OrientedLink: public SMESH_TLink
  94 {
  95   bool _reversed;
  96   SMESH_OrientedLink(const SMDS_MeshNode* n1, const SMDS_MeshNode* n2 )
  97     : SMESH_TLink( n1, n2 ), _reversed( n1 != node1() ) {}
  98 };
  99
 100 //------------------------------------------
 101 /*!
 102  * \brief SMDS_MeshNode -> gp_XYZ convertor
 103  */
 104 //------------------------------------------
 105 struct SMESH_TNodeXYZ : public gp_XYZ
 106 {
 107   const SMDS_MeshNode* _node;
 108   double               _xyz[3];
 109   SMESH_TNodeXYZ( const SMDS_MeshElement* e):gp_XYZ(0,0,0),_node(0) {
 110     if (e) {
 111       assert( e->GetType() == SMDSAbs_Node );
 112       _node = static_cast<const SMDS_MeshNode*>(e);
 113       _node->GetXYZ(_xyz); // - thread safe getting coords
 114       SetCoord( _xyz[0], _xyz[1], _xyz[2] );
 115     }
 116   }
 117   double Distance(const SMDS_MeshNode* n)       const { return (SMESH_TNodeXYZ( n )-*this).Modulus(); }
 118   double SquareDistance(const SMDS_MeshNode* n) const { return (SMESH_TNodeXYZ( n )-*this).SquareModulus(); }
 119   bool operator==(const SMESH_TNodeXYZ& other) const { return _node == other._node; }
 120 };
 121
 122 // --------------------------------------------------------------------------------
 123 // class SMESH_SequenceOfElemPtr
 124 #include <NCollection_DefineSequence.hxx>
 125
 126 class SMDS_MeshElement;
 127
 128 typedef const SMDS_MeshElement* SMDS_MeshElementPtr;
 129
 130 DEFINE_BASECOLLECTION (SMESH_BaseCollectionElemPtr, SMDS_MeshElementPtr)
 131 DEFINE_SEQUENCE (SMESH_SequenceOfElemPtr, SMESH_BaseCollectionElemPtr, SMDS_MeshElementPtr)
 132
 133
 134 // --------------------------------------------------------------------------------
 135 // class SMESH_SequenceOfNode
 136 typedef const SMDS_MeshNode* SMDS_MeshNodePtr;
 137
 138 DEFINE_BASECOLLECTION (SMESH_BaseCollectionNodePtr, SMDS_MeshNodePtr)
 139 DEFINE_SEQUENCE(SMESH_SequenceOfNode,
 140                 SMESH_BaseCollectionNodePtr, SMDS_MeshNodePtr)
 141
 142 // --------------------------------------------------------------------------------
 143 // #include "SMESHDS_DataMapOfShape.hxx"
 144
 145 // #include <NCollection_DefineIndexedMap.hxx>
 146
 147 // #include <TopoDS_Shape.hxx>
 148
 149 ///  Class SMESH_IndexedMapOfShape
 150
 151 // DEFINE_BASECOLLECTION (SMESH_BaseCollectionShape, TopoDS_Shape)
 152 // DEFINE_INDEXEDMAP (SMESH_IndexedMapOfShape, SMESH_BaseCollectionShape, TopoDS_Shape)
 153
 154 ///  Class SMESH_IndexedDataMapOfShapeIndexedMapOfShape
 155
 156 // DEFINE_BASECOLLECTION (SMESH_BaseCollectionIndexedMapOfShape, SMESH_IndexedMapOfShape)
 157 // DEFINE_INDEXEDDATAMAP (SMESH_IndexedDataMapOfShapeIndexedMapOfShape,
 158 //                        SMESH_BaseCollectionIndexedMapOfShape, TopoDS_Shape,
 159 //                        SMESH_IndexedMapOfShape)
 160
 161 // --------------------------------------------------------------------------------
 162 // class SMESH_DataMapOfElemPtrSequenceOfElemPtr
 163
 164 // SMESHUtils_EXPORT
 165 // inline Standard_Integer HashCode(SMDS_MeshElementPtr theElem,
 166 //                                  const Standard_Integer theUpper)
 167 // {
 168 //   void* anElem = (void*) theElem;
 169 //   return HashCode(anElem,theUpper);
 170 // }
 171
 172 // SMESHUtils_EXPORT
 173 // inline Standard_Boolean IsEqual(SMDS_MeshElementPtr theOne,
 174 //                                 SMDS_MeshElementPtr theTwo)
 175 // {
 176 //   return theOne == theTwo;
 177 // }
 178
 179 // DEFINE_BASECOLLECTION (SMESH_BaseCollectionSequenceOfElemPtr, SMESH_SequenceOfElemPtr)
 180 // DEFINE_DATAMAP (SMESH_DataMapOfElemPtrSequenceOfElemPtr,
 181 //                 SMESH_BaseCollectionSequenceOfElemPtr,
 182 //                 SMDS_MeshElementPtr, SMESH_SequenceOfElemPtr)
 183
 184 #endif