src/BOPDS/BOPDS_IndexRange.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_IndexRange_HeaderFile
  16 #define _BOPDS_IndexRange_HeaderFile
  17
  18 #include <Standard.hxx>
  19 #include <Standard_DefineAlloc.hxx>
  20 #include <Standard_Handle.hxx>
  21
  22 #include <Standard_Integer.hxx>
  23 #include <Standard_Boolean.hxx>
  24
  25
  26
  27 //! The class BOPDS_IndexRange is to store
  28 //! the information about range of two indices
  29 class BOPDS_IndexRange
  30 {
  31 public:
  32
  33   DEFINE_STANDARD_ALLOC
  34
  35
  36
  37   //! Empty contructor
  38     BOPDS_IndexRange();
  39 Standard_EXPORT virtual ~BOPDS_IndexRange();
  40
  41
  42   //! Modifier
  43   //! Sets the first index <theI1>  of the range
  44     void SetFirst (const Standard_Integer theI1);
  45
  46
  47   //! Modifier
  48   //! Sets the second index <theI2>  of the range
  49     void SetLast (const Standard_Integer theI2);
  50
  51
  52   //! Selector
  53   //! Returns the first index of the range
  54     Standard_Integer First() const;
  55
  56
  57   //! Selector
  58   //! Returns the second index of the range
  59     Standard_Integer Last() const;
  60
  61
  62   //! Modifier
  63   //! Sets the first index of the range  <theI1>
  64   //! Sets the second index of the range <theI2>
  65     void SetIndices (const Standard_Integer theI1, const Standard_Integer theI2);
  66
  67
  68   //! Selector
  69   //! Returns the first index of the range  <theI1>
  70   //! Returns the second index of the range <theI2>
  71     void Indices (Standard_Integer& theI1, Standard_Integer& theI2) const;
  72
  73
  74   //! Query
  75   //! Returns true if the range contains <theIndex>
  76     Standard_Boolean Contains (const Standard_Integer theIndex) const;
  77
  78   Standard_EXPORT void Dump() const;
  79
  80
  81
  82
  83 protected:
  84
  85
  86
  87   Standard_Integer myFirst;
  88   Standard_Integer myLast;
  89
  90
  91 private:
  92
  93
  94
  95
  96
  97 };
  98
  99
 100 #include <BOPDS_IndexRange.lxx>
 101
 102
 103
 104
 105
 106 #endif // _BOPDS_IndexRange_HeaderFile