Schedule.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.
 *
 *
 *  Schedule.h
 *
 *  Created on: Jan 5, 2009
 *      Author: nick
 */
 
#ifndef SCHEDULE_H_
#define SCHEDULE_H_
 
#include <vector>
#include <queue>
#include <boost/mpi/communicator.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/noncopyable.hpp>
 
namespace repast {
 
class Functor {
public:
        virtual ~Functor() = 0;
        virtual void operator()() = 0;
};
 
template<typename T>
class MethodFunctor: public Functor {
private:
        void (T::*fptr)();
        T *obj;
public:
        MethodFunctor(T *_obj, void(T::*_fptr)()) :
                fptr(_fptr), obj(_obj) {
        }
        ;
        ~MethodFunctor() {
        }
        ;
        void operator()() {
                (obj->*fptr)();
        }
};
 
class RepastEvent {
 
public:
        double tick;
        boost::shared_ptr<Functor> func_ptr;
 
        virtual ~RepastEvent();
 
};
 
class EventCompare;
 
class ScheduledEvent {
 
protected:
        RepastEvent *event;
        double start;
 
public:
        friend class EventCompare;
        ScheduledEvent(double, RepastEvent *);
        virtual ~ScheduledEvent();
        virtual bool reschedule(std::priority_queue<ScheduledEvent *, std::vector<ScheduledEvent*>, EventCompare>&) = 0;
 
        RepastEvent* get_event() {
                return event;
        }
        ;
};
 
class OneTimeEvent: public ScheduledEvent {
 
public:
        OneTimeEvent(double, RepastEvent*);
        ~OneTimeEvent();
        virtual bool reschedule(std::priority_queue<ScheduledEvent *, std::vector<ScheduledEvent*>, EventCompare>&);
};
 
class RepeatingEvent: public ScheduledEvent {
 
private:
        double interval;
 
public:
        RepeatingEvent(double start, double _interval, RepastEvent*);
        ~RepeatingEvent();
        virtual bool reschedule(std::priority_queue<ScheduledEvent *, std::vector<ScheduledEvent*>, EventCompare>&);
};
 
class EventCompare {
public:
        int operator()(const ScheduledEvent* one, const ScheduledEvent* two) {
                double tick1 = one->event->tick;
                double tick2 = two->event->tick;
                return tick1 > tick2 ? 1 : 0;
        }
};
 
class Schedule {
private:
        typedef std::priority_queue<ScheduledEvent *, std::vector<ScheduledEvent*>, EventCompare> QueueType;
        QueueType queue;
        double currentTick;
 
public:
        typedef boost::shared_ptr<Functor> FunctorPtr;
        virtual ~Schedule();
        Schedule();
 
        ScheduledEvent* schedule_event(double at, FunctorPtr functor);
 
        ScheduledEvent* schedule_event(double start, double interval, FunctorPtr func);
        void execute();
 
        double getCurrentTick() const {
                return currentTick;
        }
        ;
 
        double getNextTick() const {
                if (queue.empty())
                        return -1;
                return queue.top()->get_event()->tick;
        }
        ;
};
 
class ScheduleRunner: public boost::noncopyable {
 
private:
 
        bool go;
        Schedule schedule_;
        double globalNextTick, localNextTick;
        void nextTick();
        boost::mpi::communicator* comm;
        std::vector<boost::shared_ptr<Functor> > endEvents;
 
public:
        ScheduleRunner(boost::mpi::communicator* communicator);
        ~ScheduleRunner();
 
        ScheduledEvent* scheduleEvent(double at, Schedule::FunctorPtr func);
 
        ScheduledEvent* scheduleEvent(double start, double interval, Schedule::FunctorPtr func);
 
        void scheduleEndEvent(Schedule::FunctorPtr func);
 
        void scheduleStop(double at);
 
        void run();
 
        double currentTick() {
                return schedule_.getCurrentTick();
        }
 
        void stop();
 
        const Schedule& schedule() {
                return schedule_;
        }
};
 
}
 
#endif /* SCHEDULE_H_ */