User Manual, Developers Guide and API Documentation

RegistryProxyInterface.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
 * 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_SCHEDULER_REGISTRYPROXYINTERFACE_HPP
#define WNS_SCHEDULER_REGISTRYPROXYINTERFACE_HPP

#include <WNS/service/dll/Address.hpp>
#include <WNS/service/phy/phymode/PhyModeInterface.hpp>
#include <WNS/service/phy/phymode/PhyModeMapperInterface.hpp>
//#include <WNS/scheduler/strategy/apcstrategy/APCStrategyInterface.hpp>
//#include <WNS/scheduler/strategy/dsastrategy/DSAStrategyInterface.hpp>
#include <WNS/scheduler/SchedulingMap.hpp>
#include <WNS/scheduler/SchedulerTypes.hpp>
#include <WNS/ldk/Classifier.hpp>
#include <WNS/PowerRatio.hpp>
#include <string>

namespace wns { namespace scheduler {
        namespace apcstrategy {
            class APCStrategyInterface;
        }
        namespace dsastrategy {
            class DSAStrategyInterface;
        }
    }}

namespace wns { namespace scheduler {

        class RegistryProxyInterface {
        public:
            virtual ~RegistryProxyInterface() {};
            virtual UserID getUserForCID(ConnectionID cid) = 0;
            virtual wns::service::dll::UnicastAddress
            getPeerAddressForCID(wns::scheduler::ConnectionID cid) = 0;
            virtual ConnectionVector getConnectionsForUser(const UserID user) = 0;
            virtual ConnectionID getCIDforPDU(const wns::ldk::CompoundPtr& compound) = 0;
            virtual void setFriends(const wns::ldk::CommandTypeSpecifierInterface* _classifier) = 0;
            virtual void setFUN(const wns::ldk::fun::FUN* fun) = 0;
            virtual std::string getNameForUser(const UserID user) = 0;

            virtual wns::service::phy::phymode::PhyModeMapperInterface*
            getPhyModeMapper() const = 0;

            //virtual wns::SmartPtr<const wns::service::phy::phymode::PhyModeInterface>
            virtual wns::service::phy::phymode::PhyModeInterfacePtr
            getBestPhyMode(const wns::Ratio&) = 0;

            virtual UserID getMyUserID() = 0;
            virtual ChannelQualityOnOneSubChannel estimateTxSINRAt(const UserID user, int slot = 0) = 0;
            virtual ChannelQualityOnOneSubChannel estimateRxSINROf(const UserID user, int slot = 0) = 0;
            virtual wns::Power estimateInterferenceStdDeviation(const UserID user) = 0;
            virtual Bits getQueueSizeLimitPerConnection() = 0;

            virtual wns::service::dll::StationType
            getStationType(const wns::scheduler::UserID user) = 0;

            virtual UserSet filterReachable(UserSet users) = 0;

            virtual UserSet filterReachable(UserSet users, const int frameNr) = 0;

            virtual wns::scheduler::ConnectionSet
            filterReachable(wns::scheduler::ConnectionSet connections, const int frameNr, bool usesHARQ) = 0;

            virtual ChannelQualitiesOnAllSubBandsPtr getChannelQualities4UserOnUplink(UserID user, int frameNr) = 0;
            virtual ChannelQualitiesOnAllSubBandsPtr getChannelQualities4UserOnDownlink(UserID user, int frameNr) = 0;


            virtual wns::scheduler::PowerMap
            calcULResources(const wns::scheduler::UserSet&, unsigned long int) const = 0;

            virtual wns::scheduler::UserSet
            getActiveULUsers() const = 0;

            virtual int
            getTotalNumberOfUsers(const wns::scheduler::UserID user) = 0;

            virtual wns::scheduler::PowerCapabilities
            getPowerCapabilities(const UserID user) const = 0;

            virtual wns::scheduler::PowerCapabilities
            getPowerCapabilities() const = 0;

            virtual int
            getNumberOfPriorities() = 0;

            virtual void
            registerCID(wns::scheduler::ConnectionID cid, wns::scheduler::UserID userID/*nextHop!*/) = 0;

            virtual void
            deregisterCID(wns::scheduler::ConnectionID cid, const wns::scheduler::UserID userID) = 0;

            virtual void
            deregisterUser(const wns::scheduler::UserID userID) = 0;

            virtual ConnectionList&
            getCIDListForPriority(int priority) = 0;

            virtual wns::scheduler::ConnectionSet
            getConnectionsForPriority(int priority) = 0;

            virtual int
            getPriorityForConnection(wns::scheduler::ConnectionID cid) = 0;

            virtual bool
            getDL() const = 0;

            virtual bool
            getCQIAvailable() const = 0;
        };

        typedef wns::ldk::FUNConfigCreator<RegistryProxyInterface> RegistryCreator;
        typedef wns::StaticFactory<RegistryCreator> RegistryFactory;

    }} // namespace wns::scheduler
#endif // WNS_SCHEDULER_REGISTRYPROXYINTERFACE_HPP

---