A Discrete-Event Network Simulator
API
wimax-channel.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 WIMAX_CHANNEL_H
21 #define WIMAX_CHANNEL_H
22 
23 #include "wimax-connection.h"
24 
25 #include "ns3/channel.h"
26 #include "ns3/log.h"
27 
28 #include <list>
29 
30 namespace ns3
31 {
32 
33 class WimaxPhy;
34 class Packet;
35 class Position;
36 class PacketBurst;
37 
42 class WimaxChannel : public Channel
43 {
44  public:
49  static TypeId GetTypeId();
50  WimaxChannel();
51  ~WimaxChannel() override;
56  void Attach(Ptr<WimaxPhy> phy);
60  std::size_t GetNDevices() const override;
65  Ptr<NetDevice> GetDevice(std::size_t i) const override;
66 
75  virtual int64_t AssignStreams(int64_t stream) = 0;
76 
77  private:
82  virtual void DoAttach(Ptr<WimaxPhy> phy) = 0;
83 
88  virtual std::size_t DoGetNDevices() const = 0;
94  virtual Ptr<NetDevice> DoGetDevice(std::size_t i) const = 0;
95 };
96 
97 } // namespace ns3
98 
99 #endif /* WIMAX_CHANNEL_H */
Abstract Channel Base Class.
Definition: channel.h:45
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
a unique identifier for an interface.
Definition: type-id.h:59
The channel object to attach Wimax NetDevices.
Definition: wimax-channel.h:43
std::size_t GetNDevices() const override
static TypeId GetTypeId()
Get the type ID.
virtual std::size_t DoGetNDevices() const =0
Get number of devices on the channel.
virtual int64_t AssignStreams(int64_t stream)=0
Assign a fixed random variable stream number to the random variables used by this model.
void Attach(Ptr< WimaxPhy > phy)
attach the channel to a physical layer of a device
~WimaxChannel() override
virtual void DoAttach(Ptr< WimaxPhy > phy)=0
Attach a phy to the channel.
virtual Ptr< NetDevice > DoGetDevice(std::size_t i) const =0
Get device corresponding to index.
Ptr< NetDevice > GetDevice(std::size_t i) const override
Every class exported by the ns3 library is enclosed in the ns3 namespace.
phy
Definition: third.py:89