User Manual, Developers Guide and API Documentation

Interface.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 16, D-52074 Aachen, Germany
 * phone: ++49-241-80-27910,
 * fax: ++49-241-80-22242
 * email: info@openwns.org
 * www: http://www.openwns.org
 * _____________________________________________________________________________
 *
 * openWNS is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 2 as published by the
 * Free Software Foundation;
 *
 * openWNS is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/

#ifndef WNS_EVENTS_SCHEDULER_INTERFACE_HPP
#define WNS_EVENTS_SCHEDULER_INTERFACE_HPP

#include <WNS/events/scheduler/ICommand.hpp>
#include <WNS/events/scheduler/IEvent.hpp>
#include <WNS/events/scheduler/Callable.hpp>
#include <WNS/events/scheduler/INotification.hpp>
#include <WNS/simulator/Time.hpp>
#include <WNS/StaticFactory.hpp>
#include <WNS/NonCopyable.hpp>
#include <WNS/SubjectInterface.hpp>

namespace wns { namespace events { namespace scheduler {

    class Interface :
        virtual public SubjectInterface<IObserver>,
        private NonCopyable
    {
    public:
        wns::simulator::Time
        getTime() const;


        IEventPtr
        scheduleNow(const Callable& callable)
        {
            this->sendScheduleNowNotification();
            return this->doScheduleNow(callable);
        }

        IEventPtr
        scheduleDelay(const Callable& callable, wns::simulator::Time delay)
        {
            this->sendScheduleDelayNotification();
            return this->doSchedule(callable, this->getTime() + delay);
        }

        IEventPtr
        schedule(const Callable& callable, wns::simulator::Time at)
        {
            this->sendScheduleNotification();
            return this->doSchedule(callable, at);
        }

        ICommandPtr
        queueCommand(const Callable& callable)
        {
            return this->doQueueCommand(callable);
        }

        void
        dequeueCommand(const ICommandPtr& command);


        void
        cancelEvent(const IEventPtr& event);

        void
        reset();

        bool
        processOneEvent();

        void
        start();

        void
        stop();

        void
        stopAt(const wns::simulator::Time& time);

        size_t
        size() const;

        virtual
        ~Interface();

    protected:

        Interface();

    private:
        // NVI (non-virtual interface) - For explanation of the methods see
        // above
        virtual wns::simulator::Time
        doGetTime() const = 0;

        virtual IEventPtr
        doSchedule(const Callable& callable, wns::simulator::Time at) = 0;

        virtual IEventPtr
        doScheduleNow(const Callable& callable) = 0;

        virtual ICommandPtr
        doQueueCommand(const Callable& callable) = 0;

        virtual void
        doDequeueCommand(const ICommandPtr& command) = 0;

        virtual void
        doCancelEvent(const IEventPtr& event) = 0;

        virtual void
        doReset() = 0;

        virtual bool
        doProcessOneEvent() = 0;

        virtual void
        doStart() = 0;

        virtual void
        doStop() = 0;

        // this implementation works for all schedulers
        // a sub-class might override this method for custom-/optimization
        virtual void
        doStopAt(const wns::simulator::Time& time);

        virtual size_t
        doSize() const = 0;

        // end NVI


        //{@
        virtual void
        sendProcessOneEventNotification() = 0;

        virtual void
        sendCancelEventNotification() = 0;

        virtual void
        sendScheduleNotification() = 0;

        virtual void
        sendScheduleDelayNotification() = 0;

        virtual void
        sendScheduleNowNotification() = 0;
    };

    typedef wns::Creator<wns::events::scheduler::Interface> Creator;
    typedef StaticFactory<wns::events::scheduler::Creator> Factory;

} // scheduler
} // events
} // wns

#endif // NOT defined WNS_EVENTS_SCHEDULER_INTERFACE_HPP

---