User Manual, Developers Guide and API Documentation

HARQInterface.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. 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_HARQ_HARQINTERFACE_HPP
#define WNS_SCHEDULER_HARQ_HARQINTERFACE_HPP

#include <WNS/scheduler/SchedulingMap.hpp>
#include <WNS/service/phy/power/PowerMeasurement.hpp>
#include <WNS/StaticFactory.hpp>
#include <WNS/PyConfigViewCreator.hpp>

namespace wns { namespace scheduler { namespace harq {

class HARQInterface
{
public:
    class TimeSlotInfo
    {
    public:
        TimeSlotInfo(wns::service::phy::power::PowerMeasurementPtr pwrm, int sc):
            powerMeasurement_(pwrm),
            sc_(sc)
        {}

        wns::service::phy::power::PowerMeasurementPtr powerMeasurement_;
        int sc_;
    };

    typedef std::pair<wns::scheduler::SchedulingTimeSlotPtr, TimeSlotInfo> DecodeStatusContainerEntry;
    typedef std::list<DecodeStatusContainerEntry> DecodeStatusContainer;

    virtual ~HARQInterface() {};

    virtual void
    storeSchedulingTimeSlot(long int transportBlockID, const wns::scheduler::SchedulingTimeSlotPtr&) = 0;

    virtual void
    onTimeSlotReceived(const wns::scheduler::SchedulingTimeSlotPtr&, TimeSlotInfo info) = 0;

    virtual DecodeStatusContainer
    decode() = 0;

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

    virtual std::list<int>
    getProcessesWithRetransmissions(wns::scheduler::UserID peer) const = 0;

    virtual int
    getNumberOfRetransmissions(wns::scheduler::UserID, int processID) = 0;

    virtual bool
    hasFreeSenderProcess(wns::scheduler::UserID peer) = 0;

    virtual bool
    hasFreeReceiverProcess(wns::scheduler::UserID peer) = 0;

    virtual wns::scheduler::SchedulingTimeSlotPtr
    getNextRetransmission(wns::scheduler::UserID user, int processID) = 0;

    virtual wns::scheduler::SchedulingTimeSlotPtr
    peekNextRetransmission(wns::scheduler::UserID user, int processID) const = 0;

    virtual void
    setDownlinkHARQ(HARQInterface* downlinkHARQ) = 0;

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

    virtual std::list<int>
    getPeerProcessesWithRetransmissions(wns::scheduler::UserID peer) const = 0;
    
    virtual int
    getNumberOfPeerRetransmissions(wns::scheduler::UserID peer, int processID) const = 0;

    virtual void
    schedulePeerRetransmissions(wns::scheduler::UserID peer, int processID) = 0;

    virtual void
    sendPendingFeedback() = 0;

    STATIC_FACTORY_DEFINE(HARQInterface, wns::PyConfigViewCreator);
};

} // harq
} // scheduler
} // wns

#endif // WNS_SCHEDULER_HARQ_HARQINTERFACE_HPP

---