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
6 // This file is part of Open CASCADE Technology software library.
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.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _Aspect_GenId_HeaderFile
18 #define _Aspect_GenId_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
24 #include <Standard_Integer.hxx>
25 #include <TColStd_ListOfInteger.hxx>
26 #include <Standard_Boolean.hxx>
27 class Aspect_IdentDefinitionError;
30 //! This class permits the creation and control of integer identifiers.
38 //! Creates an available set of identifiers with the lower bound 0 and the upper bound INT_MAX / 2.
39 Standard_EXPORT Aspect_GenId();
41 //! Creates an available set of identifiers with specified range.
42 //! Raises IdentDefinitionError if theUpper is less than theLow.
43 Standard_EXPORT Aspect_GenId(const Standard_Integer theLow, const Standard_Integer theUpper);
45 //! Free all identifiers - make the whole range available again.
46 Standard_EXPORT void Free();
48 //! Free specified identifier. Warning - method has no protection against double-freeing!
49 Standard_EXPORT void Free (const Standard_Integer theId);
51 //! Returns true if there are available identifiers in range.
52 Standard_Boolean HasFree() const
54 return myFreeCount > 0
55 || myFreeIds.Extent() > 0;
58 //! Returns the number of available identifiers.
59 Standard_Integer Available() const { return myFreeCount + myFreeIds.Extent(); }
61 //! Returns the lower identifier in range.
62 Standard_Integer Lower() const { return myLowerBound; }
64 //! Returns the next available identifier.
65 //! Warning: Raises IdentDefinitionError if all identifiers are busy.
66 Standard_EXPORT Standard_Integer Next();
68 //! Generates the next available identifier.
69 //! @param theId [out] generated identifier
70 //! @return FALSE if all identifiers are busy.
71 Standard_EXPORT Standard_Boolean Next (Standard_Integer& theId);
73 //! Returns the upper identifier in range.
74 Standard_Integer Upper() const { return myUpperBound; }
76 //! Dumps the content of me into the stream
77 Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
81 Standard_Integer myFreeCount;
82 Standard_Integer myLength;
83 Standard_Integer myLowerBound;
84 Standard_Integer myUpperBound;
85 TColStd_ListOfInteger myFreeIds;
89 #endif // _Aspect_GenId_HeaderFile