AgentId.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.
 *
 *
 *  AgentId.h
 *
 *  Created on: Dec 23, 2008
 *      Author: nick
 */
 
#ifndef AGENTID_H_
#define AGENTID_H_
 
#include <iostream>
#include <boost/serialization/access.hpp>
#include <boost/mpi.hpp>
 
namespace repast {
 
class AgentId {
 
        friend std::ostream& operator<<(std::ostream& os, const AgentId& id);
        friend bool operator==(const AgentId &one, const AgentId &two);
        friend bool operator<(const AgentId &one, const AgentId &two);
        friend class boost::serialization::access;
 
private:
        int id_, startProc_, agentType_, currentProc_;
        std::size_t hash;
 
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version) {
                ar & id_;
                ar & startProc_;
                ar & agentType_;
                ar & currentProc_;
                ar & hash;
        }
 
public:
 
        AgentId() {
        }
 
        AgentId(int id, int startProc, int agentType, int currentProc = -1);
 
        virtual ~AgentId();
 
        int id() const {
                return id_;
        }
 
        int startingRank() const {
                return startProc_;
        }
 
        int agentType() const {
                return agentType_;
        }
 
        int currentRank() const {
                return currentProc_;
        }
 
        void currentRank(int val) {
                currentProc_ = val;
        }
 
        std::size_t hashcode() const {
                return hash;
        }
};
 
std::ostream& operator<<(std::ostream& os, const AgentId& id);
 
bool operator==(const AgentId &one, const AgentId &two);
 
bool operator!=(const AgentId &one, const AgentId &two);
 
        
bool operator<(const AgentId &one, const AgentId &two);
 
struct HashId {
        std::size_t operator()(const AgentId& id) const {
                return id.hashcode();
        }
};
 
template<typename AgentType>
struct AgentHashId {
        std::size_t operator()(const AgentType* agent) const {
                return agent->getId().hashcode();
        }
};
 
class Agent {
 
public:
        virtual ~Agent() {
        }
 
        virtual AgentId& getId() = 0;
 
        virtual const AgentId& getId() const = 0;
};
 
 
template<typename T>
struct IsAgentType {
        int _typeId;
        
        IsAgentType(){
                _typeId = 0; 
        }
        
        IsAgentType(int typeId) :
                _typeId(typeId) {
        }
 
        bool operator()(const boost::shared_ptr<T>& ptr) {
                return ptr->getId().agentType() == _typeId;
        }
 
        bool operator()(const T* agent) {
                return agent->getId().agentType() == _typeId;
        }
};
 
 
template<typename T>
struct IsNotType {
        int _typeId;
        
        IsNotType(){
                _typeId = 0; 
        }
        
        IsNotType(int typeId) :
                _typeId(typeId) {
        }
 
        bool operator()(const boost::shared_ptr<T>& ptr) {
                return ptr->getId().agentType() != _typeId;
        }
 
        bool operator()(const T* agent) {
                return agent->getId().agentType() != _typeId;
        }
 
};
 
}
 
#endif /* AGENTID_H_ */