/usr/include/ns3.17/ns3/bs-uplink-scheduler.h is in libns3-dev 3.17+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2007,2008 INRIA
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
*/
#ifndef UPLINK_SCHEDULER_H
#define UPLINK_SCHEDULER_H
#include <stdint.h>
#include "ul-mac-messages.h"
#include "ns3/nstime.h"
#include "wimax-phy.h"
#include "service-flow-record.h"
#include "service-flow.h"
namespace ns3 {
class BaseStationNetDevice;
class SSRecord;
class ServiceFlow;
class ServiceFlowRecord;
/**
* \ingroup wimax
* \brief Virtual class for uplink scheduler.
*/
class UplinkScheduler : public Object
{
public:
UplinkScheduler (void);
UplinkScheduler (Ptr<BaseStationNetDevice> bs);
virtual ~UplinkScheduler (void);
static TypeId GetTypeId (void);
virtual uint8_t GetNrIrOppsAllocated (void) const;
virtual void SetNrIrOppsAllocated (uint8_t nrIrOppsAllocated);
virtual bool GetIsIrIntrvlAllocated (void) const;
virtual void SetIsIrIntrvlAllocated (bool isIrIntrvlAllocated);
virtual bool GetIsInvIrIntrvlAllocated (void) const;
virtual void SetIsInvIrIntrvlAllocated (bool isInvIrIntrvlAllocated);
virtual std::list<OfdmUlMapIe> GetUplinkAllocations (void) const;
virtual Time GetTimeStampIrInterval (void);
virtual void SetTimeStampIrInterval (Time timeStampIrInterval);
virtual Time GetDcdTimeStamp (void) const;
virtual void SetDcdTimeStamp (Time dcdTimeStamp);
virtual Time GetUcdTimeStamp (void) const;
virtual void SetUcdTimeStamp (Time ucdTimeStamp);
virtual Ptr<BaseStationNetDevice> GetBs (void);
virtual void SetBs (Ptr<BaseStationNetDevice> bs);
/**
* Determines if channel descriptors sent in the current frame are
* required to be updated
*/
virtual void GetChannelDescriptorsToUpdate (bool&, bool&, bool&, bool&) = 0;
virtual uint32_t CalculateAllocationStartTime (void) = 0;
virtual void AddUplinkAllocation (OfdmUlMapIe &ulMapIe,
const uint32_t &allocationSize,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols) = 0;
virtual void Schedule (void) = 0;
virtual void ServiceUnsolicitedGrants (const SSRecord *ssRecord,
enum ServiceFlow::SchedulingType schedulingType,
OfdmUlMapIe &ulMapIe,
const WimaxPhy::ModulationType modulationType,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols) = 0;
virtual void ServiceBandwidthRequests (const SSRecord *ssRecord,
enum ServiceFlow::SchedulingType schedulingType,
OfdmUlMapIe &ulMapIe,
const WimaxPhy::ModulationType modulationType,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols) = 0;
virtual bool ServiceBandwidthRequests (ServiceFlow *serviceFlow,
enum ServiceFlow::SchedulingType schedulingType,
OfdmUlMapIe &ulMapIe,
const WimaxPhy::ModulationType modulationType,
uint32_t &symbolsToAllocation,
uint32_t &availableSymbols) = 0;
virtual void AllocateInitialRangingInterval (uint32_t &symbolsToAllocation, uint32_t &availableSymbols) = 0;
virtual void SetupServiceFlow (SSRecord *ssRecord, ServiceFlow *serviceFlow) = 0;
virtual void ProcessBandwidthRequest (const BandwidthRequestHeader &bwRequestHdr) = 0;
virtual void InitOnce (void) = 0;
virtual void OnSetRequestedBandwidth (ServiceFlowRecord *sfr) = 0;
private:
Ptr<BaseStationNetDevice> m_bs;
std::list<OfdmUlMapIe> m_uplinkAllocations;
Time m_timeStampIrInterval;
uint8_t m_nrIrOppsAllocated;
bool m_isIrIntrvlAllocated;
bool m_isInvIrIntrvlAllocated;
Time m_dcdTimeStamp;
Time m_ucdTimeStamp;
};
} // namespace ns3
#endif /* UPLINK_SCHEDULER_H */
|