(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / core / pool_func.cpp
blobf8ff93cecc94502c34f8ae4f8addbbfa16da69be
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD 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.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
10 /** @file pool_func.cpp Implementation of PoolBase methods. */
12 #include "../stdafx.h"
13 #include "pool_type.hpp"
15 #include "../safeguards.h"
17 /**
18 * Destructor removes this object from the pool vector and
19 * deletes the vector itself if this was the last item removed.
21 /* virtual */ PoolBase::~PoolBase()
23 PoolVector *pools = PoolBase::GetPools();
24 pools->Erase(pools->Find(this));
25 if (pools->Length() == 0) delete pools;
28 /**
29 * Clean all pools of given type.
30 * @param pt pool types to clean.
32 /* static */ void PoolBase::Clean(PoolType pt)
34 PoolVector *pools = PoolBase::GetPools();
35 PoolBase **end = pools->End();
36 for (PoolBase **ppool = pools->Begin(); ppool != end; ppool++) {
37 PoolBase *pool = *ppool;
38 if (pool->type & pt) pool->CleanPool();