smesh/src/SMDS/SMDS_MeshNode.hxx

//  Copyright (C) 2007-2010  CEA/DEN, EDF R&D, OPEN CASCADE
//
//  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
//  This library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 2.1 of the License.
//
//  This library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with this library; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
//  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//

//  SMESH SMDS : implementaion of Salome mesh data structure
//  File   : SMDS_MeshNode.hxx
//  Module : SMESH
//
#ifndef _SMDS_MeshNode_HeaderFile
#define _SMDS_MeshNode_HeaderFile

#include "SMESH_SMDS.hxx"

#include "SMDS_MeshElement.hxx"
#include "SMDS_Position.hxx"
#include <NCollection_List.hxx>

class SMDS_EXPORT SMDS_MeshNode:public SMDS_MeshElement
{

public:
  SMDS_MeshNode(double x, double y, double z);

  double X() const;
  double Y() const;
  double Z() const;
  void setXYZ(double x, double y, double z);

  void AddInverseElement(const SMDS_MeshElement * ME);
  void RemoveInverseElement(const SMDS_MeshElement * parent);
  void ClearInverseElements();
  SMDS_ElemIteratorPtr GetInverseElementIterator(SMDSAbs_ElementType type=SMDSAbs_All) const;
  int NbInverseElements(SMDSAbs_ElementType type=SMDSAbs_All) const;

  void SetPosition(const SMDS_PositionPtr& aPos);
  const SMDS_PositionPtr& GetPosition() const;

  SMDSAbs_ElementType GetType() const;
  SMDSAbs_EntityType  GetEntityType() const {return SMDSEntity_Node;}

  friend bool operator<(const SMDS_MeshNode& e1, const SMDS_MeshNode& e2);
  void Print(std::ostream & OS) const;

  /*!
   * \brief Return node by its index
   * \param ind - node index
   * \retval const SMDS_MeshNode* - the node
   */
  virtual const SMDS_MeshNode* GetNode(const int) const { return this; }
  virtual int NbNodes() const;

protected:
  SMDS_ElemIteratorPtr
  elementsIterator(SMDSAbs_ElementType type) const;

private:
  double myX, myY, myZ;
  SMDS_PositionPtr myPosition;
  NCollection_List<const SMDS_MeshElement*> myInverseElements;
};

#endif