src/SMDS/SMDS_MeshElement.hxx

   1 //  SMESH SMDS : implementaion of Salome mesh data structure
   2 //
   3 //  Copyright (C) 2003  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 //
  23 //
  24 //  File   : SMDS_MeshElement.hxx
  25 //  Module : SMESH
  26
  27 #ifndef _SMDS_MeshElement_HeaderFile
  28 #define _SMDS_MeshElement_HeaderFile
  29
  30 #include "SMDSAbs_ElementType.hxx"
  31 #include "SMDS_MeshObject.hxx"
  32 #include "SMDS_ElemIterator.hxx"
  33 #include "SMDS_MeshElementIDFactory.hxx"
  34
  35 //#ifdef WNT
  36 //#include <SALOME_WNT.hxx>
  37 //#else
  38 //#define SALOME_WNT_EXPORT
  39 //#endif
  40
  41 #if defined WNT && defined WIN32 && defined SMDS_EXPORTS
  42 #define SMDS_WNT_EXPORT __declspec( dllexport )
  43 #else
  44 #define SMDS_WNT_EXPORT
  45 #endif
  46
  47 #include <vector>
  48 #include <iostream>
  49
  50 class SMDS_MeshNode;
  51 class SMDS_MeshEdge;
  52 class SMDS_MeshFace;
  53
  54 ///////////////////////////////////////////////////////////////////////////////
  55 /// Base class for elements
  56 ///////////////////////////////////////////////////////////////////////////////
  57 class SMDS_WNT_EXPORT SMDS_MeshElement:public SMDS_MeshObject
  58 {
  59 public:
  60
  61   SMDS_ElemIteratorPtr nodesIterator() const;
  62   SMDS_ElemIteratorPtr edgesIterator() const;
  63   SMDS_ElemIteratorPtr facesIterator() const;
  64   virtual SMDS_ElemIteratorPtr elementsIterator(SMDSAbs_ElementType type) const;
  65
  66   virtual int NbNodes() const;
  67   virtual int NbEdges() const;
  68   virtual int NbFaces() const;
  69   int GetID() const;
  70
  71   ///Return the type of the current element
  72   virtual SMDSAbs_ElementType GetType() const = 0;
  73   virtual bool IsPoly() const { return false; };
  74   virtual bool IsQuadratic() const;
  75
  76   virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
  77
  78   friend std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
  79   friend bool SMDS_MeshElementIDFactory::BindID(int ID,SMDS_MeshElement*elem);
  80
  81   // ===========================
  82   //  Access to nodes by index
  83   // ===========================
  84   /*!
  85    * \brief Return node by its index
  86     * \param ind - node index
  87     * \retval const SMDS_MeshNode* - the node
  88    *
  89    * Index is wrapped if it is out of a valid range
  90    */
  91   virtual const SMDS_MeshNode* GetNode(const int ind) const;
  92
  93   /*!
  94    * \brief Return true if index of node is valid (0 <= ind < NbNodes())
  95     * \param ind - node index
  96     * \retval bool - index check result
  97    */
  98   virtual bool IsValidIndex(const int ind) const;
  99
 100   /*!
 101    * \brief Return a valid node index, fixing the given one if necessary
 102     * \param ind - node index
 103     * \retval int - valid node index
 104    */
 105   int WrappedIndex(const int ind) const {
 106     if ( ind < 0 ) return -( ind % NbNodes());
 107     if ( ind >= NbNodes() ) return ind % NbNodes();
 108     return ind;
 109   }
 110
 111   /*!
 112    * \brief Check if a node belongs to the element
 113     * \param node - the node to check
 114     * \retval int - node index within the element, -1 if not found
 115    */
 116   int GetNodeIndex( const SMDS_MeshNode* node ) const;
 117
 118 protected:
 119   SMDS_MeshElement(int ID=-1);
 120   virtual void Print(std::ostream & OS) const;
 121
 122 private:
 123   int myID;
 124 };
 125
 126 #endif