Open CASCADE Technology  6.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions
Aspect_GenId Class Reference

This class permits the creation and control of all
identifiers.
Warning: An identifier is an integer.
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 Low, const Standard_Integer Up)
 
Creates an available set of identifiers with the lower <br>
  bound <Low> and the upper bound <Up>. <br>

Warning: Raises IdentDefinitionError if <Up> is less than <Low>.
//! Copies the content of <Other> into <me>.
More...

 
void Free ()
 Frees all identifiers of <me>.
More...
 
void Free (const Standard_Integer Id)
 Frees the identifier <Id> of <me>.
More...
 
Standard_Integer Available () const
 Returns the number of available identifiers of <me>.
More...
 
Standard_Integer Lower () const
 Returns the lower bound of <me>.
More...
 
Standard_Integer Next ()
 
Returns an available identifier of <me>. <br>

Warning: Raises IdentDefinitionError if all identifiers are busy.
More...

 
Standard_Integer Upper () const
 Returns the upper bound of <me>.
More...
 

Detailed Description

This class permits the creation and control of all
identifiers.
Warning: An identifier is an integer.

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.

Aspect_GenId::Aspect_GenId ( const Standard_Integer  Low,
const Standard_Integer  Up 
)

Creates an available set of identifiers with the lower <br>
  bound <Low> and the upper bound <Up>. <br>

Warning: Raises IdentDefinitionError if <Up> is less than <Low>.
//! Copies the content of <Other> into <me>.

Member Function Documentation

Standard_Integer Aspect_GenId::Available ( ) const

Returns the number of available identifiers of <me>.

void Aspect_GenId::Free ( )

Frees all identifiers of <me>.

void Aspect_GenId::Free ( const Standard_Integer  Id)

Frees the identifier <Id> of <me>.

Standard_Integer Aspect_GenId::Lower ( ) const

Returns the lower bound of <me>.

Standard_Integer Aspect_GenId::Next ( )

Returns an available identifier of <me>. <br>

Warning: Raises IdentDefinitionError if all identifiers are busy.

Standard_Integer Aspect_GenId::Upper ( ) const

Returns the upper bound of <me>.


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