khanat-opennel-code/code/nel/include/nel/misc/historic.h

100 lines
3 KiB
C++

// NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
// Copyright (C) 2010 Winch Gate Property Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
#ifndef NL_HISTORIC_H
#define NL_HISTORIC_H
#include "nel/misc/types_nl.h"
#include <deque>
namespace NLMISC
{
/** An historic with user defined size.
* An historic is just a fifo with constraint on size
*
* \author Nicolas Vizerie
* \author Nevrax France
* \date 2004
*/
template <class T>
class CHistoric
{
public:
CHistoric(uint maxSize = 0) : _MaxSize(maxSize) {}
// Add a value at end of historic. If historic is full then the oldest entry is removed
inline void push(const T &value);
// Pop the value at the end of jistoric
inline void pop();
// Return true is there are no values in the historics.
bool empty() const { return _Historic.empty(); }
// Get max number of entries in the historic.
uint getMaxSize() const { return _MaxSize; }
// Set number of entries in the historic. Oldest entries are removed
inline void setMaxSize(uint maxSize);
// Get current size of historic
uint getSize() const { return (uint)_Historic.size(); }
// Access to an element in history, 0 being the oldest, size - 1 being the lastest added element
const T &operator[](uint index) const { return _Historic[index]; /* let STL do out of range check */ }
// Clear historic
void clear() { _Historic.clear(); }
private:
std::deque<T> _Historic;
uint _MaxSize;
};
////////////////////
// IMPLEMENTATION //
////////////////////
// ****************************************************************************************************
template <class T>
inline void CHistoric<T>::push(const T &value)
{
nlassert(_Historic.size() <= _MaxSize);
if (_MaxSize == 0) return;
if (getSize() == _MaxSize)
{
_Historic.pop_front();
}
_Historic.push_back(value);
}
// ****************************************************************************************************
template <class T>
inline void CHistoric<T>::pop()
{
nlassert(!_Historic.empty());
_Historic.pop_back();
}
// ****************************************************************************************************
template <class T>
inline void CHistoric<T>::setMaxSize(uint maxSize)
{
if (maxSize < getSize())
{
uint toRemove = std::min(getSize() - maxSize, getSize());
_Historic.erase(_Historic.begin(), _Historic.begin() + toRemove);
}
_MaxSize = maxSize;
}
}
#endif