include/opencascade/Aspect_GenId.hxx

0001 // Created on: 1992-05-13
0002 // Created by: NW,JPB,CAL
0003 // Copyright (c) 1992-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 _Aspect_GenId_HeaderFile
0018 #define _Aspect_GenId_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TColStd_ListOfInteger.hxx>
0025 #include <Standard_Boolean.hxx>
0026
0027
0028 //! This class permits the creation and control of integer identifiers.
0029 class Aspect_GenId
0030 {
0031 public:
0032
0033   DEFINE_STANDARD_ALLOC
0034
0035
0036   //! Creates an available set of identifiers with the lower bound 0 and the upper bound INT_MAX / 2.
0037   Standard_EXPORT Aspect_GenId();
0038
0039   //! Creates an available set of identifiers with specified range.
0040   //! Raises IdentDefinitionError if theUpper is less than theLow.
0041   Standard_EXPORT Aspect_GenId(const Standard_Integer theLow, const Standard_Integer theUpper);
0042
0043   //! Free all identifiers - make the whole range available again.
0044   Standard_EXPORT void Free();
0045
0046   //! Free specified identifier. Warning - method has no protection against double-freeing!
0047   Standard_EXPORT void Free (const Standard_Integer theId);
0048
0049   //! Returns true if there are available identifiers in range.
0050   Standard_Boolean HasFree() const
0051   {
0052     return myFreeCount > 0
0053         || myFreeIds.Extent() > 0;
0054   }
0055
0056   //! Returns the number of available identifiers.
0057   Standard_Integer Available() const { return myFreeCount + myFreeIds.Extent(); }
0058
0059   //! Returns the lower identifier in range.
0060   Standard_Integer Lower() const { return myLowerBound; }
0061
0062   //! Returns the next available identifier.
0063   //! Warning: Raises IdentDefinitionError if all identifiers are busy.
0064   Standard_EXPORT Standard_Integer Next();
0065
0066   //! Generates the next available identifier.
0067   //! @param theId [out] generated identifier
0068   //! @return FALSE if all identifiers are busy.
0069   Standard_EXPORT Standard_Boolean Next (Standard_Integer& theId);
0070
0071   //! Returns the upper identifier in range.
0072   Standard_Integer Upper() const { return myUpperBound; }
0073
0074   //! Dumps the content of me into the stream
0075   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
0076
0077 private:
0078
0079   Standard_Integer myFreeCount;
0080   Standard_Integer myLength;
0081   Standard_Integer myLowerBound;
0082   Standard_Integer myUpperBound;
0083   TColStd_ListOfInteger myFreeIds;
0084
0085 };
0086
0087 #endif // _Aspect_GenId_HeaderFile