This class permits the creation and control of integer identifiers. More...

#include <Aspect_GenId.hxx>

Public Member Functions
	Aspect_GenId ()
	Creates an available set of identifiers with the lower bound 0 and the upper bound INT_MAX / 2. More...

	Aspect_GenId (const Standard_Integer theLow, const Standard_Integer theUpper)
	Creates an available set of identifiers with specified range. Raises IdentDefinitionError if theUpper is less than theLow. More...

void	Free ()
	Free all identifiers - make the whole range available again. More...

void	Free (const Standard_Integer theId)
	Free specified identifier. Warning - method has no protection against double-freeing! More...

Standard_Boolean	HasFree () const
	Returns true if there are available identifiers in range. More...

Standard_Integer	Available () const
	Returns the number of available identifiers. More...

Standard_Integer	Lower () const
	Returns the lower identifier in range. More...

Standard_Integer	Next ()
	Returns the next available identifier. Warning: Raises IdentDefinitionError if all identifiers are busy. More...

Standard_Integer	Upper () const
	Returns the upper identifier in range. More...

Detailed Description

This class permits the creation and control of integer identifiers.

Constructor & Destructor Documentation

Aspect_GenId::Aspect_GenId ( )

Creates an available set of identifiers with the lower bound 0 and the upper bound INT_MAX / 2.

Creates an available set of identifiers with specified range. Raises IdentDefinitionError if theUpper is less than theLow.

Standard_Integer Aspect_GenId::Available ( ) const

Returns the number of available identifiers.

void Aspect_GenId::Free ( )

Free all identifiers - make the whole range available again.

void Aspect_GenId::Free ( const Standard_Integer theId )

Free specified identifier. Warning - method has no protection against double-freeing!

Standard_Boolean Aspect_GenId::HasFree ( ) const

Returns true if there are available identifiers in range.

Standard_Integer Aspect_GenId::Lower ( ) const

Returns the lower identifier in range.

Standard_Integer Aspect_GenId::Next ( )

Returns the next available identifier. Warning: Raises IdentDefinitionError if all identifiers are busy.

Standard_Integer Aspect_GenId::Upper ( ) const

Returns the upper identifier in range.

The documentation for this class was generated from the following file: