khanat-opennel-code/code/nel/include/nel/3d/ptr_set.h
2010-05-06 02:08:41 +02:00

95 lines
2.4 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_PTR_SET_H
#define NL_PTR_SET_H
#include "nel/misc/types_nl.h"
#include <set>
namespace NL3D
{
// ***************************************************************************
/**
* This is a Tool class. A ptr set is simply a set of object Pointer, with simple insert/erase/clear.
* The allocation is made at insertion by client, but deletion is automatically done by erase/clear.
* You got public acces to the STL set, so be aware of what you do!!
* \author Lionel Berenguier
* \author Nevrax France
* \date 2001
*/
template<class T> class CPtrSet
{
public:
std::set<T*> Set;
public:
/// \name Object
// @{
CPtrSet() {}
~CPtrSet() {clear();}
// @}
/// \name insertion/deletion.
// @{
/** insert a new element to the set. You should pass a conventionnal allocated object.
* For simplicity, return newObject!!!
*/
T *insert(T *newObject)
{
Set.insert(newObject);
return newObject;
}
/** erase an element from the set. nlerror(errorString) if not found!! NO OP if NULL.
* For simplicity, return newObject!!!
*/
void erase(T *objectToRemove, const char *errorString= "Object do not exist in the set")
{
if(!objectToRemove)
return;
if(Set.erase(objectToRemove)!=1)
nlerror(errorString);
else
delete objectToRemove;
}
/** Delete all element from the set, and clear the set
*/
void clear()
{
typename std::set<T*>::iterator it;
for(it= Set.begin();it!=Set.end();it++)
{
delete *it;
}
Set.clear();
}
// @}
};
} // NL3D
#endif // NL_PTR_SET_H
/* End of ptr_set.h */