LeechCraft 0.6.70-16373-g319c272718
Modular cross-platform feature rich live environment.
Loading...
Searching...
No Matches
LC::Util::IDPool< T > Class Template Referencefinal

A simple pool of identificators of the given type. More...

#include "idpool.h"

Public Member Functions

 IDPool (const T &id=T())
 Creates a pool with the given initial value.
 
GetID ()
 Returns next ID.
 
void SetID (T id)
 Forcefully sets the current ID.
 
void FreeID (T id)
 Frees the id.
 
QByteArray SaveState () const
 Saves the state of this pool.
 
void LoadState (const QByteArray &state)
 Recovers the state of this pool.
 

Detailed Description

template<typename T>
class LC::Util::IDPool< T >

A simple pool of identificators of the given type.

This class holds a pool of identificators of the given type T. It is very simple and produces consecutive IDs, this T should support operator++().

Definition at line 26 of file idpool.h.

Constructor & Destructor Documentation

◆ IDPool()

template<typename T >
LC::Util::IDPool< T >::IDPool ( const T & id = T ())
inlineexplicit

Creates a pool with the given initial value.

Parameters
[in]idThe initial value of the pool.

Definition at line 34 of file idpool.h.

Member Function Documentation

◆ FreeID()

template<typename T >
void LC::Util::IDPool< T >::FreeID ( T id)
inline

Frees the id.

Parameters
[in]idThe ID to free.

Definition at line 61 of file idpool.h.

◆ GetID()

template<typename T >
T LC::Util::IDPool< T >::GetID ( )
inline

Returns next ID.

Returns
Next ID in the pool.

Definition at line 43 of file idpool.h.

◆ LoadState()

template<typename T >
void LC::Util::IDPool< T >::LoadState ( const QByteArray & state)
inline

Recovers the state of this pool.

Parameters
[in]stateThe state of this pool obtained from SaveState().

Definition at line 87 of file idpool.h.

◆ SaveState()

template<typename T >
QByteArray LC::Util::IDPool< T >::SaveState ( ) const
inline

Saves the state of this pool.

Returns
The serialized state of this pool.

Definition at line 70 of file idpool.h.

◆ SetID()

template<typename T >
void LC::Util::IDPool< T >::SetID ( T id)
inline

Forcefully sets the current ID.

Parameters
[in]idThe new current ID.

Definition at line 52 of file idpool.h.


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