src/SMDS/SMDS_MeshElement.hxx

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