Grid.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.
 *
 *
 *  Grid.h
 *
 *  Created on: Aug 10, 2010
 *      Author: nick
 */
 
#ifndef GRID_H_
#define GRID_H_
 
#include <vector>
#include <utility>
 
#include "Projection.h"
#include "Point.h"
#include "GridDimensions.h"
#include "AgentId.h"
 
namespace repast {
 
template<typename T, typename GPType>
class Grid: public Projection<T> {
  typedef typename Projection<T>::RADIUS RADIUS;
 
public:
 
        Grid(std::string name) :
                Projection<T> (name) {
        }
        virtual ~Grid() {
        }
 
        virtual bool contains(const AgentId& id) = 0;
 
        virtual bool moveTo(const AgentId& id, const Point<GPType>& pt) = 0;
 
        virtual std::pair<bool, Point<GPType> > moveByVector(const T* agent, double distance,
                        const std::vector<double>& anglesInRadians) = 0;
 
        virtual std::pair<bool, Point<GPType> >
        moveByDisplacement(const T* agent, const std::vector<GPType>& displacement) = 0;
 
        virtual const GridDimensions dimensions() const = 0;
 
  virtual const GridDimensions bounds() const = 0;
 
 
        virtual T* getObjectAt(const Point<GPType>& pt) const = 0;
 
        virtual void getObjectsAt(const Point<GPType>& pt, std::vector<T*>& out) const = 0;
 
        virtual bool getLocation(const T* agent, std::vector<GPType>& out) const = 0;
 
        virtual bool getLocation(const AgentId& id, std::vector<GPType>& out) const = 0;
 
        virtual void getDisplacement(const Point<GPType>& pt1, const Point<GPType>& pt2, std::vector<GPType>& out) const = 0;
 
        virtual double getDistance(const Point<GPType>& pt1, const Point<GPType>& pt2) const = 0;
 
        virtual double getDistanceSq(const Point<GPType>& pt1, const Point<GPType>& pt2) const = 0;
 
        virtual void
        translate(const Point<GPType>& location, const Point<GPType>& displacement, std::vector<GPType>& out) const = 0;
 
        virtual void
        transform(const std::vector<GPType>& location, std::vector<GPType>& out) const = 0;
 
        virtual bool isPeriodic() const = 0;
 
  virtual ProjectionInfoPacket* getProjectionInfo(AgentId id, bool secondaryInfo = false, std::set<AgentId>* secondaryIds = 0, int destProc = -1 ) = 0;
 
  virtual void updateProjectionInfo(ProjectionInfoPacket* pip, Context<T>* context) = 0;
 
  virtual void getRequiredAgents(std::set<AgentId>& agentsToTest, std::set<AgentId>& agentsRequired, RADIUS radius = Projection<T>::PRIMARY){} // Grids allow all agents to be dropped b/c agent info not dependent on other agents
 
  virtual void getAgentsToPush(std::set<AgentId>& agentsToTest, std::map<int, std::set<AgentId> >& agentsToPush) = 0;
 
  virtual bool keepsAgentsOnSyncProj(){ return false; }
 
  virtual bool sendsSecondaryAgentsOnStatusExchange(){ return false; }
 
  virtual void getInfoExchangePartners(std::set<int>& psToSendTo, std::set<int>& psToReceiveFrom) = 0;
 
  virtual void getAgentStatusExchangePartners(std::set<int>& psToSendTo, std::set<int>& psToReceiveFrom) = 0;
 
  virtual void cleanProjectionInfo(std::set<AgentId>& agentsToKeep){}; // Grids don't do this
 
};
 
}
 
#endif /* GRID_H_ */