A Discrete-Event Network Simulator
API
ss-scheduler.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007,2008 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Jahanzeb Farooq <jahanzeb.farooq@sophia.inria.fr>
19  */
20 
21 /* SS outbound scheduler as per in Section 6.3.5.1 */
22 
23 #ifndef SS_SCHEDULER_H
24 #define SS_SCHEDULER_H
25 
26 #include <stdint.h>
27 #include "ns3/packet.h"
28 #include "ns3/packet-burst.h"
29 #include "wimax-phy.h"
30 #include "wimax-mac-header.h"
31 
32 namespace ns3 {
33 
34 class SubscriberStationNetDevice;
35 class WimaxConnection;
36 
41 class SSScheduler : public Object
42 {
43 
44 public:
49  static TypeId GetTypeId (void);
56  ~SSScheduler (void);
57 
62  void SetPollMe (bool pollMe);
67  bool GetPollMe (void) const;
75  Ptr<PacketBurst> Schedule (uint16_t availableSymbols,
76  WimaxPhy::ModulationType modulationType,
77  MacHeaderType::HeaderType packetType, Ptr<WimaxConnection> &connection);
78 
79 
80  void DoDispose (void);
81 protected:
82 private:
84  SSScheduler (const SSScheduler &);
90 
97  bool m_pollMe;
98 
99 };
100 
101 } // namespace ns3
102 
103 #endif /* SS_SCHEDULER_H */
HeaderType
Header type enumeration.
void DoDispose(void)
Destructor implementation.
Definition: ss-scheduler.cc:59
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
Ptr< PacketBurst > Schedule(uint16_t availableSymbols, WimaxPhy::ModulationType modulationType, MacHeaderType::HeaderType packetType, Ptr< WimaxConnection > &connection)
Definition: ss-scheduler.cc:77
void SetPollMe(bool pollMe)
Set poll me value.
Definition: ss-scheduler.cc:65
bool m_pollMe
poll me flag
Definition: ss-scheduler.h:97
Ptr< SubscriberStationNetDevice > m_ss
the subscriber station
Definition: ss-scheduler.h:96
SSScheduler(Ptr< SubscriberStationNetDevice > ss)
Constructor.
Definition: ss-scheduler.cc:48
bool GetPollMe(void) const
Get the poll me value.
Definition: ss-scheduler.cc:71
Every class exported by the ns3 library is enclosed in the ns3 namespace.
static TypeId GetTypeId(void)
Get the type ID.
Definition: ss-scheduler.cc:40
ModulationType
ModulationType enumeration.
Definition: wimax-phy.h:49
A base class which provides memory management and object aggregation.
Definition: object.h:87
Ptr< WimaxConnection > SelectConnection(void)
Select connection.
a unique identifier for an interface.
Definition: type-id.h:58
SSScheduler & operator=(const SSScheduler &)
assignment operator