A Discrete-Event Network Simulator
API
spectrum-phy.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 CTTC
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: Nicola Baldo <nbaldo@cttc.es>
19  */
20 
21 #ifndef SPECTRUM_PHY_H
22 #define SPECTRUM_PHY_H
23 
24 
25 #include <ns3/object.h>
26 #include <ns3/nstime.h>
27 
28 namespace ns3 {
29 
30 class PacketBurst;
31 class SpectrumChannel;
32 class MobilityModel;
33 class AntennaModel;
34 class SpectrumValue;
35 class SpectrumModel;
36 class NetDevice;
37 struct SpectrumSignalParameters;
38 
45 class SpectrumPhy : public Object
46 {
47 
48 public:
49  SpectrumPhy ();
50  virtual ~SpectrumPhy ();
51 
56  static TypeId GetTypeId (void);
57 
63  virtual void SetDevice (Ptr<NetDevice> d) = 0;
64 
70  virtual Ptr<NetDevice> GetDevice () const = 0;
71 
77  virtual void SetMobility (Ptr<MobilityModel> m) = 0;
78 
84  virtual Ptr<MobilityModel> GetMobility () const = 0;
85 
91  virtual void SetChannel (Ptr<SpectrumChannel> c) = 0;
92 
99  virtual Ptr<const SpectrumModel> GetRxSpectrumModel () const = 0;
100 
106  virtual Ptr<AntennaModel> GetRxAntenna () const = 0;
107 
113  virtual void StartRx (Ptr<SpectrumSignalParameters> params) = 0;
114 
115 private:
121  SpectrumPhy (SpectrumPhy const &);
129 };
130 
131 
132 
133 
134 
135 
136 
137 
138 
139 } // namespace ns3
140 
141 
142 
143 
144 
145 #endif /* SPECTRUM_PHY_H */
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
Abstract base class for Spectrum-aware PHY layers.
Definition: spectrum-phy.h:45
virtual void StartRx(Ptr< SpectrumSignalParameters > params)=0
Notify the SpectrumPhy instance of an incoming signal.
virtual void SetDevice(Ptr< NetDevice > d)=0
Set the associated NetDevice instance.
virtual Ptr< AntennaModel > GetRxAntenna() const =0
Get the AntennaModel used by the NetDevice for reception.
virtual Ptr< const SpectrumModel > GetRxSpectrumModel() const =0
SpectrumPhy & operator=(SpectrumPhy const &)
Copy constructor.
virtual void SetChannel(Ptr< SpectrumChannel > c)=0
Set the channel attached to this device.
virtual Ptr< MobilityModel > GetMobility() const =0
Get the associated MobilityModel instance.
static TypeId GetTypeId(void)
Get the type ID.
Definition: spectrum-phy.cc:36
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual Ptr< NetDevice > GetDevice() const =0
Get the associated NetDevice instance.
virtual void SetMobility(Ptr< MobilityModel > m)=0
Set the mobility model associated with this device.
A base class which provides memory management and object aggregation.
Definition: object.h:87
a unique identifier for an interface.
Definition: type-id.h:58
virtual ~SpectrumPhy()
Definition: spectrum-phy.cc:50