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