A Discrete-Event Network Simulator
API
bs-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 /* BS outbound scheduler as per in Section 6.3.5.1 */
21 
22 #ifndef BS_SCHEDULER_H
23 #define BS_SCHEDULER_H
24 
25 #include "dl-mac-messages.h"
26 #include "service-flow.h"
27 #include "wimax-phy.h"
28 
29 #include "ns3/packet-burst.h"
30 #include "ns3/packet.h"
31 
32 #include <list>
33 
34 namespace ns3
35 {
36 
37 class BaseStationNetDevice;
38 class GenericMacHeader;
39 class WimaxConnection;
40 class Cid;
41 
47 class BSScheduler : public Object
48 {
49  public:
50  BSScheduler();
57  ~BSScheduler() override;
58 
63  static TypeId GetTypeId();
64 
70  virtual std::list<std::pair<OfdmDlMapIe*, Ptr<PacketBurst>>>* GetDownlinkBursts() const = 0;
80  uint8_t diuc,
81  WimaxPhy::ModulationType modulationType,
82  Ptr<PacketBurst> burst) = 0;
83 
87  virtual void Schedule() = 0;
93  virtual bool SelectConnection(Ptr<WimaxConnection>& connection) = 0;
94 
103  WimaxPhy::ModulationType modulationType,
104  uint32_t availableSymbols) = 0;
105 
115  virtual void SetBs(Ptr<BaseStationNetDevice> bs);
116 
125  int availableSymbols,
126  WimaxPhy::ModulationType modulationType);
127 
128  private:
130  std::list<std::pair<OfdmDlMapIe*, Ptr<PacketBurst>>>* m_downlinkBursts;
131 };
132 
133 } // namespace ns3
134 
135 #endif /* BS_SCHEDULER_H */
BaseStation Scheduler.
Definition: bs-scheduler.h:48
virtual void Schedule()=0
the scheduling function for the downlink subframe.
~BSScheduler() override
Definition: bs-scheduler.cc:67
virtual Ptr< BaseStationNetDevice > GetBs()
Get the base station.
Definition: bs-scheduler.cc:89
virtual void SetBs(Ptr< BaseStationNetDevice > bs)
Set the base station.
Definition: bs-scheduler.cc:83
virtual bool SelectConnection(Ptr< WimaxConnection > &connection)=0
Selects a connection from the list of connections having packets to be sent .
Ptr< BaseStationNetDevice > m_bs
base station
Definition: bs-scheduler.h:129
virtual void AddDownlinkBurst(Ptr< const WimaxConnection > connection, uint8_t diuc, WimaxPhy::ModulationType modulationType, Ptr< PacketBurst > burst)=0
This function adds a downlink burst to the list of downlink bursts scheduled for the next downlink su...
static TypeId GetTypeId()
Get the type ID.
Definition: bs-scheduler.cc:47
virtual Ptr< PacketBurst > CreateUgsBurst(ServiceFlow *serviceFlow, WimaxPhy::ModulationType modulationType, uint32_t availableSymbols)=0
Creates a downlink UGS burst.
std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * m_downlinkBursts
down link bursts
Definition: bs-scheduler.h:130
virtual std::list< std::pair< OfdmDlMapIe *, Ptr< PacketBurst > > > * GetDownlinkBursts() const =0
This function returns all the downlink bursts scheduled for the next downlink sub-frame.
bool CheckForFragmentation(Ptr< WimaxConnection > connection, int availableSymbols, WimaxPhy::ModulationType modulationType)
Check if the packet fragmentation is possible for transport connection.
Definition: bs-scheduler.cc:95
A base class which provides memory management and object aggregation.
Definition: object.h:89
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
This class implements service flows as described by the IEEE-802.16 standard.
Definition: service-flow.h:43
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.