A Discrete-Event Network Simulator
API
wimax-channel.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 #ifndef WIMAX_CHANNEL_H
22 #define WIMAX_CHANNEL_H
23 
24 #include <list>
25 #include "ns3/channel.h"
26 #include "wimax-connection.h"
27 #include "ns3/log.h"
28 
29 namespace ns3 {
30 
31 class WimaxPhy;
32 class Packet;
33 class Position;
34 class PacketBurst;
35 
40 class WimaxChannel : public Channel
41 {
42 public:
47  static TypeId GetTypeId (void);
48  WimaxChannel (void);
49  virtual ~WimaxChannel (void);
54  void Attach (Ptr<WimaxPhy> phy);
58  std::size_t GetNDevices (void) const;
63  Ptr<NetDevice> GetDevice (std::size_t i) const;
64 
73  virtual int64_t AssignStreams (int64_t stream) = 0;
74 
75 private:
80  virtual void DoAttach (Ptr<WimaxPhy> phy) = 0;
81 
86  virtual std::size_t DoGetNDevices (void) const = 0;
92  virtual Ptr<NetDevice> DoGetDevice (std::size_t i) const = 0;
93 };
94 
95 } // namespace ns3
96 
97 #endif /* WIMAX_CHANNEL_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::WimaxChannel::DoGetNDevices
virtual std::size_t DoGetNDevices(void) const =0
Get number of devices on the channel.
ns3::WimaxChannel::WimaxChannel
WimaxChannel(void)
Definition: wimax-channel.cc:40
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
ns3::WimaxChannel::DoGetDevice
virtual Ptr< NetDevice > DoGetDevice(std::size_t i) const =0
Get device corresponding to index.
ns3::WimaxChannel
The channel object to attach Wimax NetDevices.
Definition: wimax-channel.h:41
ns3::WimaxChannel::GetNDevices
std::size_t GetNDevices(void) const
Definition: wimax-channel.cc:55
ns3::WimaxChannel::GetDevice
Ptr< NetDevice > GetDevice(std::size_t i) const
Definition: wimax-channel.cc:61
ns3::WimaxChannel::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: wimax-channel.cc:32
wimax-connection.h
ns3::Channel
Abstract Channel Base Class.
Definition: channel.h:44
ns3::WimaxChannel::~WimaxChannel
virtual ~WimaxChannel(void)
Definition: wimax-channel.cc:44
ns3::WimaxChannel::Attach
void Attach(Ptr< WimaxPhy > phy)
attach the channel to a physical layer of a device
Definition: wimax-channel.cc:49
ns3::WimaxChannel::DoAttach
virtual void DoAttach(Ptr< WimaxPhy > phy)=0
Attach a phy to the channel.
third.phy
phy
Definition: third.py:93
ns3::WimaxChannel::AssignStreams
virtual int64_t AssignStreams(int64_t stream)=0
Assign a fixed random variable stream number to the random variables used by this model.