include/opencascade/MAT_Node.hxx

0001 // Created on: 1993-04-30
0002 // Created by: Yves FRICAUD
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _MAT_Node_HeaderFile
0018 #define _MAT_Node_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <Standard_Real.hxx>
0025 #include <Standard_Transient.hxx>
0026 #include <MAT_SequenceOfArc.hxx>
0027 #include <MAT_SequenceOfBasicElt.hxx>
0028 class MAT_Arc;
0029
0030
0031 class MAT_Node;
0032 DEFINE_STANDARD_HANDLE(MAT_Node, Standard_Transient)
0033
0034 //! Node of Graph.
0035 class MAT_Node : public Standard_Transient
0036 {
0037
0038 public:
0039
0040
0041   Standard_EXPORT MAT_Node(const Standard_Integer GeomIndex, const Handle(MAT_Arc)& LinkedArc, const Standard_Real Distance);
0042
0043   //! Returns the index associated of the geometric
0044   //! representation of <me>.
0045   Standard_EXPORT Standard_Integer GeomIndex() const;
0046
0047   //! Returns the index associated of the node
0048   Standard_EXPORT Standard_Integer Index() const;
0049
0050   //! Returns in <S> the Arcs linked to <me>.
0051   Standard_EXPORT void LinkedArcs (MAT_SequenceOfArc& S) const;
0052
0053   //! Returns  in <S> the BasicElts equidistant
0054   //! to <me>.
0055   Standard_EXPORT void NearElts (MAT_SequenceOfBasicElt& S) const;
0056
0057   Standard_EXPORT Standard_Real Distance() const;
0058
0059   //! Returns True if <me> is a pending Node.
0060   //! (ie : the number of Arc Linked = 1)
0061   Standard_EXPORT Standard_Boolean PendingNode() const;
0062
0063   //! Returns True if <me> belongs to the figure.
0064   Standard_EXPORT Standard_Boolean OnBasicElt() const;
0065
0066   //! Returns True if the distance of <me> is Infinite
0067   Standard_EXPORT Standard_Boolean Infinite() const;
0068
0069   //! Set the index associated of the node
0070   Standard_EXPORT void SetIndex (const Standard_Integer anIndex);
0071
0072   Standard_EXPORT void SetLinkedArc (const Handle(MAT_Arc)& anArc);
0073
0074
0075
0076
0077   DEFINE_STANDARD_RTTIEXT(MAT_Node,Standard_Transient)
0078
0079 protected:
0080
0081
0082
0083
0084 private:
0085
0086
0087   Standard_Integer nodeIndex;
0088   Standard_Integer geomIndex;
0089   Standard_Address aLinkedArc;
0090   Standard_Real distance;
0091
0092
0093 };
0094
0095
0096
0097
0098
0099
0100
0101 #endif // _MAT_Node_HeaderFile