src/Aspect/Aspect_GenId.hxx

   1 // Created on: 1992-05-13
   2 // Created by: NW,JPB,CAL
   3 // Copyright (c) 1992-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _Aspect_GenId_HeaderFile
  18 #define _Aspect_GenId_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <TColStd_ListOfInteger.hxx>
  25 #include <Standard_Boolean.hxx>
  26
  27
  28 //! This class permits the creation and control of integer identifiers.
  29 class Aspect_GenId
  30 {
  31 public:
  32
  33   DEFINE_STANDARD_ALLOC
  34
  35
  36   //! Creates an available set of identifiers with the lower bound 0 and the upper bound INT_MAX / 2.
  37   Standard_EXPORT Aspect_GenId();
  38
  39   //! Creates an available set of identifiers with specified range.
  40   //! Raises IdentDefinitionError if theUpper is less than theLow.
  41   Standard_EXPORT Aspect_GenId(const Standard_Integer theLow, const Standard_Integer theUpper);
  42
  43   //! Free all identifiers - make the whole range available again.
  44   Standard_EXPORT void Free();
  45
  46   //! Free specified identifier. Warning - method has no protection against double-freeing!
  47   Standard_EXPORT void Free (const Standard_Integer theId);
  48
  49   //! Returns true if there are available identifiers in range.
  50   Standard_Boolean HasFree() const
  51   {
  52     return myFreeCount > 0
  53         || myFreeIds.Extent() > 0;
  54   }
  55
  56   //! Returns the number of available identifiers.
  57   Standard_Integer Available() const { return myFreeCount + myFreeIds.Extent(); }
  58
  59   //! Returns the lower identifier in range.
  60   Standard_Integer Lower() const { return myLowerBound; }
  61
  62   //! Returns the next available identifier.
  63   //! Warning: Raises IdentDefinitionError if all identifiers are busy.
  64   Standard_EXPORT Standard_Integer Next();
  65
  66   //! Generates the next available identifier.
  67   //! @param theId [out] generated identifier
  68   //! @return FALSE if all identifiers are busy.
  69   Standard_EXPORT Standard_Boolean Next (Standard_Integer& theId);
  70
  71   //! Returns the upper identifier in range.
  72   Standard_Integer Upper() const { return myUpperBound; }
  73
  74   //! Dumps the content of me into the stream
  75   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
  76
  77 private:
  78
  79   Standard_Integer myFreeCount;
  80   Standard_Integer myLength;
  81   Standard_Integer myLowerBound;
  82   Standard_Integer myUpperBound;
  83   TColStd_ListOfInteger myFreeIds;
  84
  85 };
  86
  87 #endif // _Aspect_GenId_HeaderFile