Aspect_GenId Class Reference

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.
	Aspect_GenId (const int theLow, const int theUpper)
	Creates an available set of identifiers with specified range. Raises IdentDefinitionError if theUpper is less than theLow.
void	Free ()
	Free all identifiers - make the whole range available again.
void	Free (const int theId)
	Free specified identifier. Warning - method has no protection against double-freeing!
bool	HasFree () const
	Returns true if there are available identifiers in range.
int	Available () const
	Returns the number of available identifiers.
int	Lower () const
	Returns the lower identifier in range.
int	Next ()
	Returns the next available identifier. Warning: Raises IdentDefinitionError if all identifiers are busy.
bool	Next (int &theId)
	Generates the next available identifier.
int	Upper () const
	Returns the upper identifier in range.
void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.

Detailed Description

This class permits the creation and control of integer identifiers.

Constructor & Destructor Documentation

Aspect_GenId() [1/2]

Aspect_GenId::Aspect_GenId

(

)

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

Aspect_GenId() [2/2]

Aspect_GenId::Aspect_GenId	(	const int	theLow,
		const int	theUpper )

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

Member Function Documentation

Available()

int Aspect_GenId::Available ( ) const

inline

Returns the number of available identifiers.

DumpJson()

void Aspect_GenId::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

Dumps the content of me into the stream.

Free() [1/2]

void Aspect_GenId::Free

(

)

Free all identifiers - make the whole range available again.

Free() [2/2]

void Aspect_GenId::Free

(

const int

theId

)

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

HasFree()

bool Aspect_GenId::HasFree ( ) const

inline

Returns true if there are available identifiers in range.

Lower()

int Aspect_GenId::Lower ( ) const

inline

Returns the lower identifier in range.

Next() [1/2]

int Aspect_GenId::Next

(

)

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

Next() [2/2]

bool Aspect_GenId::Next

(

int &

theId

)

Generates the next available identifier.

Parameters

[out]

theId

generated identifier

Returns

FALSE if all identifiers are busy.

Upper()

int Aspect_GenId::Upper ( ) const

inline

Returns the upper identifier in range.

---

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

• Aspect_GenId.hxx