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-2009
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 5, D-52074 Aachen, Germany
 * 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 WIMAC_SCHEDULER_SCHEDULERINTERFACE_HPP
#define WIMAC_SCHEDULER_SCHEDULERINTERFACE_HPP

#include <WNS/ldk/Compound.hpp>
#include <WNS/ldk/FUNConfigCreator.hpp>
#include <WNS/StaticFactory.hpp>
#include <WNS/scheduler/queue/QueueInterface.hpp>
#include <WNS/scheduler/harq/HARQInterface.hpp>
#include <WIMAC/FUConfigCreator.hpp>
#include <WIMAC/scheduler/RegistryProxyWiMAC.hpp>

namespace wns {
namespace ldk {

class Connector;
class Receptor;

namespace fun {

class FUN;

}
}
}

namespace wimac {
    namespace scheduler {

        class Interface {
        public:
            virtual ~Interface() {}


            bool isAccepting(const wns::ldk::CompoundPtr& compound) const
            {
                return doIsAccepting(compound);
            }

            virtual void schedule(const wns::ldk::CompoundPtr&) = 0;

            virtual void startScheduling() = 0;

            virtual void finishScheduling() = 0;

            virtual void deliverSchedule(wns::ldk::Connector*) = 0;

            virtual void setFUN(wns::ldk::fun::FUN*) = 0;

            virtual void setReceptor(wns::ldk::Receptor*) = 0;

            virtual void setDuration(const wns::simulator::Time&) = 0;

            virtual wns::simulator::Time getDuration() const = 0;

            virtual wns::scheduler::queue::QueueInterface* 
            getQueue() const = 0;

            virtual wimac::scheduler::RegistryProxyWiMAC* 
            getRegistryProxy() = 0;

            virtual wns::scheduler::harq::HARQInterface*
            getHARQ() = 0;

        private:

            virtual bool doIsAccepting(const wns::ldk::CompoundPtr& compound) const = 0;

        };

    typedef wimac::FUConfigCreator<Interface> SchedulerCreator;
    typedef wns::StaticFactory<SchedulerCreator> SchedulerFactory;

    }
}
#endif

---