object_pool.hpp

Go to the documentation of this file.

/*
 *    This file is part of ACADO Toolkit.
 *
 *    ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
 *    Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
 *    Milan Vukov, Rien Quirynen, KU Leuven.
 *    Developed within the Optimization in Engineering Center (OPTEC)
 *    under supervision of Moritz Diehl. All rights reserved.
 *
 *    ACADO Toolkit is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 3 of the License, or (at your option) any later version.
 *
 *    ACADO Toolkit 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
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with ACADO Toolkit; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */// Object pool, a template

#ifndef ACADO_TOOLKIT_OBJECT_POOL
#define ACADO_TOOLKIT_OBJECT_POOL

#include <map>
#include <vector>
#include <utility>

template
<
        typename T,
        typename C = std::less< T >
>
class ObjectPool
{
public:
        ObjectPool()
        {}
        
        ~ObjectPool()
        {}
        
        bool add(const T& obj)
        {
                typename poolMap::const_iterator it = pool.find( obj );
                if (it == pool.end())
                {
                        pool.insert( std::make_pair(obj, true) );

                        return true;
                }

                return false;
        }

        bool busy( void )
        {
                if (pool.size() == 0)
                        return true;

                typename poolMap::const_iterator it = pool.begin();
                for (; it != pool.end(); ++it)
                        if (it->second == false)
                                return false;

                return true;
        }

        bool acquire(T& obj)
        {
                if ( pool.size() )
                {
                        typename poolMap::iterator it = pool.begin();
                        for (; it != pool.end(); ++it)
                        {
                                if (it->second == false)
                                        break;
                        }
                        
                        if (it != pool.end())
                        {
                                obj = it->first;
                                it->second = true;

                                return true;
                        }
                }       
                        
                return false;
        }
        
        bool release(const T& obj)
        {
                typename poolMap::iterator it = pool.find( obj );
                if (it != pool.end())
                {
                        it->second = false;

                        return true;
                }

                return false;
        }
        
        std::vector< T > getPool() const
        {
                std::vector< T > v;

                typename poolMap::const_iterator it = pool.begin();
                for (; it != pool.end(); ++it)
                        v.push_back( it->first );

                return v;
        }

        unsigned size( void )
        {
                return pool.size();
        }

private:
        typedef std::map<T, bool, C> poolMap;

        poolMap pool;
};

#endif // ACADO_TOOLKIT_OBJECT_POOL