A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
bs-uplink-scheduler.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2007,2008 INRIA
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
18 */
19
20#ifndef UPLINK_SCHEDULER_H
21#define UPLINK_SCHEDULER_H
22
23#include "service-flow-record.h"
24#include "service-flow.h"
25#include "ul-mac-messages.h"
26#include "wimax-phy.h"
27
28#include "ns3/nstime.h"
29
30#include <stdint.h>
31
32namespace ns3
33{
34
35class BaseStationNetDevice;
36class SSRecord;
37class ServiceFlow;
38class ServiceFlowRecord;
39
44class UplinkScheduler : public Object
45{
46 public:
54 ~UplinkScheduler() override;
55
60 static TypeId GetTypeId();
61
65 virtual uint8_t GetNrIrOppsAllocated() const;
70 virtual void SetNrIrOppsAllocated(uint8_t nrIrOppsAllocated);
71
75 virtual bool GetIsIrIntrvlAllocated() const;
80 virtual void SetIsIrIntrvlAllocated(bool isIrIntrvlAllocated);
81
85 virtual bool GetIsInvIrIntrvlAllocated() const;
90 virtual void SetIsInvIrIntrvlAllocated(bool isInvIrIntrvlAllocated);
91
95 virtual std::list<OfdmUlMapIe> GetUplinkAllocations() const;
96
105 virtual void SetTimeStampIrInterval(Time timeStampIrInterval);
106
110 virtual Time GetDcdTimeStamp() const;
115 virtual void SetDcdTimeStamp(Time dcdTimeStamp);
116
120 virtual Time GetUcdTimeStamp() const;
125 virtual void SetUcdTimeStamp(Time ucdTimeStamp);
126
135 virtual void SetBs(Ptr<BaseStationNetDevice> bs);
140 virtual void GetChannelDescriptorsToUpdate(bool&, bool&, bool&, bool&) = 0;
152 virtual void AddUplinkAllocation(OfdmUlMapIe& ulMapIe,
153 const uint32_t& allocationSize,
154 uint32_t& symbolsToAllocation,
155 uint32_t& availableSymbols) = 0;
159 virtual void Schedule() = 0;
169 virtual void ServiceUnsolicitedGrants(const SSRecord* ssRecord,
170 ServiceFlow::SchedulingType schedulingType,
171 OfdmUlMapIe& ulMapIe,
172 const WimaxPhy::ModulationType modulationType,
173 uint32_t& symbolsToAllocation,
174 uint32_t& availableSymbols) = 0;
184 virtual void ServiceBandwidthRequests(const SSRecord* ssRecord,
185 ServiceFlow::SchedulingType schedulingType,
186 OfdmUlMapIe& ulMapIe,
187 const WimaxPhy::ModulationType modulationType,
188 uint32_t& symbolsToAllocation,
189 uint32_t& availableSymbols) = 0;
200 virtual bool ServiceBandwidthRequests(ServiceFlow* serviceFlow,
201 ServiceFlow::SchedulingType schedulingType,
202 OfdmUlMapIe& ulMapIe,
203 const WimaxPhy::ModulationType modulationType,
204 uint32_t& symbolsToAllocation,
205 uint32_t& availableSymbols) = 0;
211 virtual void AllocateInitialRangingInterval(uint32_t& symbolsToAllocation,
212 uint32_t& availableSymbols) = 0;
218 virtual void SetupServiceFlow(SSRecord* ssRecord, ServiceFlow* serviceFlow) = 0;
223 virtual void ProcessBandwidthRequest(const BandwidthRequestHeader& bwRequestHdr) = 0;
224
228 virtual void InitOnce() = 0;
229
235
236 private:
238 std::list<OfdmUlMapIe> m_uplinkAllocations;
245};
246
247} // namespace ns3
248
249#endif /* UPLINK_SCHEDULER_H */
This class implements the bandwidth-request mac Header as described by IEEE Standard for Local and me...
A base class which provides memory management and object aggregation.
Definition: object.h:89
This class implements the UL-MAP_IE message as described by "IEEE Standard for Local and metropolitan...
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:78
This class is used by the base station to store some information related to subscriber station in the...
Definition: ss-record.h:46
This class implements service flows as described by the IEEE-802.16 standard.
Definition: service-flow.h:43
SchedulingType
section 11.13.11 Service flow scheduling type, page 701
Definition: service-flow.h:62
this class implements a structure to manage some parameters and statistics related to a service flow
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:59
ModulationType
ModulationType enumeration.
Definition: wimax-phy.h:54
Every class exported by the ns3 library is enclosed in the ns3 namespace.