src/BOPDS/BOPDS_Pave.hxx

   1 // Created by: Peter KURNEV
   2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   3 //
   4 // This file is part of Open CASCADE Technology software library.
   5 //
   6 // This library is free software; you can redistribute it and/or modify it under
   7 // the terms of the GNU Lesser General Public License version 2.1 as published
   8 // by the Free Software Foundation, with special exception defined in the file
   9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  10 // distribution for complete text of the license and disclaimer of any warranty.
  11 //
  12 // Alternatively, this file may be used under the terms of Open CASCADE
  13 // commercial license or contractual agreement.
  14
  15 #ifndef _BOPDS_Pave_HeaderFile
  16 #define _BOPDS_Pave_HeaderFile
  17
  18 #include <Standard.hxx>
  19 #include <Standard_DefineAlloc.hxx>
  20 #include <Standard_Handle.hxx>
  21
  22 #include <Standard_Real.hxx>
  23 #include <Standard_Boolean.hxx>
  24
  25
  26
  27 //! The class BOPDS_Pave is to store
  28 //! information about vertex on an edge
  29 class BOPDS_Pave
  30 {
  31 public:
  32
  33   DEFINE_STANDARD_ALLOC
  34
  35
  36
  37   //! Empty constructor
  38     BOPDS_Pave();
  39
  40   //! Modifier
  41   //! Sets the index of vertex <theIndex>
  42     void SetIndex (const Standard_Integer theIndex);
  43
  44
  45   //! Selector
  46   //! Returns the index of vertex
  47     Standard_Integer Index() const;
  48
  49
  50   //! Modifier
  51   //! Sets the parameter of vertex <theParameter>
  52     void SetParameter (const Standard_Real theParameter);
  53
  54
  55   //! Selector
  56   //! Returns the parameter of vertex
  57     Standard_Real Parameter() const;
  58
  59
  60   //! Selector
  61   //! Returns the index of vertex <theIndex>
  62   //! Returns the parameter of vertex <theParameter>
  63     void Contents (Standard_Integer& theIndex, Standard_Real& theParameter) const;
  64
  65
  66   //! Query
  67   //! Returns true if thr parameter od this is less
  68   //! than the parameter of  <theOther>
  69     Standard_Boolean IsLess (const BOPDS_Pave& theOther) const;
  70   Standard_Boolean operator < (const BOPDS_Pave& theOther) const
  71 {
  72   return IsLess(theOther);
  73 }
  74
  75
  76   //! Query
  77   //! Returns true if thr parameter od this is equal
  78   //! to the parameter of  <theOther>
  79     Standard_Boolean IsEqual (const BOPDS_Pave& theOther) const;
  80   Standard_Boolean operator == (const BOPDS_Pave& theOther) const
  81 {
  82   return IsEqual(theOther);
  83 }
  84
  85   Standard_EXPORT void Dump() const;
  86
  87
  88
  89
  90 protected:
  91
  92
  93
  94   Standard_Integer myIndex;
  95   Standard_Real myParameter;
  96
  97
  98 private:
  99
 100
 101
 102
 103
 104 };
 105
 106
 107 #include <BOPDS_Pave.lxx>
 108
 109
 110
 111
 112
 113 #endif // _BOPDS_Pave_HeaderFile