SingleOccupancy.h

/*
 *   Repast for High Performance Computing (Repast HPC)
 *
 *   Copyright (c) 2010 Argonne National Laboratory
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with
 *   or without modification, are permitted provided that the following
 *   conditions are met:
 *
 *     Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *     Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *
 *     Neither the name of the Argonne National Laboratory nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 *   PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE TRUSTEES OR
 *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 *   EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 *  SingleOccupancy.h
 *
 *  Created on: Aug 11, 2010
 *      Author: nick
 */
 
#ifndef SINGLEOCCUPANCY_H_
#define SINGLEOCCUPANCY_H_
 
#include <boost/unordered_map.hpp>
#include <boost/shared_ptr.hpp>
 
#include "Point.h"
 
namespace repast {
 
template<typename T, typename GPType>
class SingleOccupancy {
 
private:
        typedef typename boost::unordered_map<Point<GPType> , boost::shared_ptr<T>, HashGridPoint<GPType> > LocationMap;
        typedef typename LocationMap::iterator LocationMapIter;
        typedef typename LocationMap::const_iterator LocationMapConstIter;
 
        LocationMap locations;
 
public:
 
        T* get(const Point<GPType>& location) const;
 
        void getAll(const Point<GPType>& location, std::vector<T*>& out) const;
 
        bool put(boost::shared_ptr<T>& agent, const Point<GPType>& location);
 
        void remove(boost::shared_ptr<T>& agent, const Point<GPType>& location);
 
};
 
template<typename T, typename GPType>
T* SingleOccupancy<T, GPType>::get(const Point<GPType>& location) const {
        LocationMapConstIter iter = locations.find(location);
        if (iter == locations.end())
                return NULL;
        return iter->second.get();
}
 
template<typename T, typename GPType>
void SingleOccupancy<T, GPType>::getAll(const Point<GPType>& location, std::vector<T*>& out) const {
        T* agent = get(location);
        if (agent != NULL) {
                out.push_back(agent);
        }
}
 
template<typename T, typename GPType>
bool SingleOccupancy<T, GPType>::put(boost::shared_ptr<T>& agent, const Point<GPType>& location) {
        LocationMapIter iter = locations.find(location);
        // already occupied
        if (iter != locations.end())
                return false;
        locations[location] = agent;
        return true;
}
 
template<typename T, typename GPType>
void SingleOccupancy<T, GPType>::remove(boost::shared_ptr<T>& agent, const Point<GPType>& location) {
        locations.erase(location);
}
 
}
 
#endif /* SINGLEOCCUPANCY_H_ */