42cf5bc1 |
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 <Standard_Integer.hxx> |
25 | #include <TColStd_ListOfInteger.hxx> |
26 | #include <Standard_Boolean.hxx> |
27 | class Aspect_IdentDefinitionError; |
28 | |
29 | |
30 | //! This class permits the creation and control of integer identifiers. |
31 | class Aspect_GenId |
32 | { |
33 | public: |
34 | |
35 | DEFINE_STANDARD_ALLOC |
36 | |
37 | |
38 | //! Creates an available set of identifiers with the lower bound 0 and the upper bound INT_MAX / 2. |
39 | Standard_EXPORT Aspect_GenId(); |
40 | |
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); |
44 | |
45 | //! Free all identifiers - make the whole range available again. |
46 | Standard_EXPORT void Free(); |
47 | |
48 | //! Free specified identifier. Warning - method has no protection against double-freeing! |
49 | Standard_EXPORT void Free (const Standard_Integer theId); |
50 | |
51 | //! Returns true if there are available identifiers in range. |
1c728f2d |
52 | Standard_Boolean HasFree() const |
53 | { |
54 | return myFreeCount > 0 |
55 | || myFreeIds.Extent() > 0; |
56 | } |
42cf5bc1 |
57 | |
58 | //! Returns the number of available identifiers. |
1c728f2d |
59 | Standard_Integer Available() const { return myFreeCount + myFreeIds.Extent(); } |
42cf5bc1 |
60 | |
61 | //! Returns the lower identifier in range. |
1c728f2d |
62 | Standard_Integer Lower() const { return myLowerBound; } |
42cf5bc1 |
63 | |
64 | //! Returns the next available identifier. |
65 | //! Warning: Raises IdentDefinitionError if all identifiers are busy. |
66 | Standard_EXPORT Standard_Integer Next(); |
1c728f2d |
67 | |
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); |
42cf5bc1 |
72 | |
73 | //! Returns the upper identifier in range. |
1c728f2d |
74 | Standard_Integer Upper() const { return myUpperBound; } |
42cf5bc1 |
75 | |
76 | private: |
77 | |
42cf5bc1 |
78 | Standard_Integer myFreeCount; |
79 | Standard_Integer myLength; |
80 | Standard_Integer myLowerBound; |
81 | Standard_Integer myUpperBound; |
82 | TColStd_ListOfInteger myFreeIds; |
83 | |
42cf5bc1 |
84 | }; |
85 | |
42cf5bc1 |
86 | #endif // _Aspect_GenId_HeaderFile |