AgentRequest.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.
 *
 * AgentRequest.h
 *
 *  Created on: Aug 19, 2010
 *      Author: nick
 */
 
#ifndef AGENTREQUEST_H_
#define AGENTREQUEST_H_
 
#include <iostream>
#include <boost/serialization/access.hpp>
#include <boost/serialization/vector.hpp>
#include <set>
 
#include "AgentId.h"
 
 
namespace repast {
 
class AgentRequest {
 
        friend std::ostream& operator<<(std::ostream& os, const AgentRequest& request);
        friend class boost::serialization::access;
 
  // To allow AgentImporters to edit agent requests before sending them out
  friend class Importer_LIST;
  friend class Importer_SET;
  friend class Importer_MAP_int;
 
private:
        int source, target;
        std::vector<AgentId> requestedAgents_;
  std::vector<AgentId> cancellations_;
 
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version) {
                ar & source;
                ar & target;
                ar & requestedAgents_;
                ar & cancellations_;
        }
 
public:
        // No-arg constructor for serialization
        AgentRequest() :
        source(-1), target(-1) {
        }
 
        AgentRequest(int sourceProcess);
 
        AgentRequest(int sourceProcess, int targetProcess);
 
        void addAll(const AgentRequest& req);
        
        void addAllRequests(const AgentRequest& req);
 
        void addAllCancellations(const AgentRequest& req);
                
        const std::vector<AgentId>& requestedAgents() const {
                return requestedAgents_;
        }
 
        const std::vector<AgentId>& cancellations() const {
                return cancellations_;
        }
        
        bool remove(const AgentId& id, bool removeAllInstances = true);
 
        bool removeRequest(const AgentId& id, bool removeAllInstances = true);
 
        bool removeCancellation(const AgentId& id, bool removeAllInstances = true);
        
        void targets(std::set<int>& targets);
 
        void targetsOfRequests(std::set<int>& targets);
        
        void targetsOfCancellations(std::set<int>& targets);    
        
        void addRequest(const AgentId& id);
 
        void addCancellation(const AgentId& id);
        
        int requestCount() const {
                return requestedAgents_.size() + cancellations_.size();
        }
        
        int requestCountRequested() const {
            return requestedAgents_.size();
        }
        
        int requestCountCancellations() const {
            return cancellations_.size();
        }
        
        bool contains(const AgentId& id);
 
        bool containsInRequests(const AgentId& id);
        
        bool containsInCancellations(const AgentId& id);
 
        int sourceProcess() const {
                return source;
        }
 
        int targetProcess() const {
                return target;
        }
 
};
 
std::ostream& operator<<(std::ostream& os, const AgentRequest& request);
 
 
}
 
#endif /* AGENTREQUEST_H_ */