A Discrete-Event Network Simulator
API
tv-spectrum-transmitter.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014 University of Washington
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: Benjamin Cizdziel <ben.cizdziel@gmail.com>
19  */
20 
21 #ifndef TV_SPECTRUM_TRANSMITTER_H
22 #define TV_SPECTRUM_TRANSMITTER_H
23 
24 #include <ns3/spectrum-value.h>
25 #include <ns3/spectrum-phy.h>
26 #include <ns3/spectrum-channel.h>
27 #include <ns3/antenna-model.h>
28 #include <ns3/spectrum-signal-parameters.h>
29 #include <ns3/mobility-model.h>
30 #include <ns3/net-device.h>
31 
32 namespace ns3
33 {
34 
35 
47 {
48 
49 public:
53  enum TvType
54  {
58  };
59 
61  virtual ~TvSpectrumTransmitter ();
62 
67  static TypeId GetTypeId (void);
68 
69  // inherited from SpectrumPhy
72  void SetDevice (Ptr<NetDevice> d);
74  Ptr<NetDevice> GetDevice () const;
75  // device does not use Rx but these pure virtual methods must be implemented
79 
86 
110  virtual void CreateTvPsd ();
111 
117  Ptr<SpectrumValue> GetTxPsd () const;
118 
122  virtual void Start ();
123 
127  virtual void Stop ();
128 
129 
130 private:
135 
137  virtual void SetupTx ();
138 
139  enum TvType m_tvType;
142  double m_basePsd;
146  bool m_active;
147 
148 };
149 
150 } // namespace ns3
151 
152 #endif /* TV_SPECTRUM_TRANSMITTER_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::TvSpectrumTransmitter::SetMobility
void SetMobility(Ptr< MobilityModel > m)
Set the mobility model associated with this device.
Definition: tv-spectrum-transmitter.cc:133
ns3::TvSpectrumTransmitter::SetupTx
virtual void SetupTx()
Sets up signal to be transmitted.
Definition: tv-spectrum-transmitter.cc:561
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::TvSpectrumTransmitter::m_active
bool m_active
True if TV transmitter is transmitting.
Definition: tv-spectrum-transmitter.h:146
ns3::TvSpectrumTransmitter::GetRxAntenna
Ptr< AntennaModel > GetRxAntenna() const
Get the AntennaModel used by the NetDevice for reception.
Definition: tv-spectrum-transmitter.cc:168
ns3::TvSpectrumTransmitter::GetChannel
Ptr< SpectrumChannel > GetChannel() const
Get the spectrum channel.
Definition: tv-spectrum-transmitter.cc:182
ns3::TvSpectrumTransmitter::m_txPsd
Ptr< SpectrumValue > m_txPsd
Pointer to power spectral density of TV transmitter's signal.
Definition: tv-spectrum-transmitter.h:143
ns3::TvSpectrumTransmitter::m_startFrequency
double m_startFrequency
Start frequency (in Hz) of TV transmitter's signal.
Definition: tv-spectrum-transmitter.h:140
ns3::TvSpectrumTransmitter::TvSpectrumTransmitter
TvSpectrumTransmitter()
Definition: tv-spectrum-transmitter.cc:40
ns3::TvSpectrumTransmitter::m_channel
Ptr< SpectrumChannel > m_channel
Pointer to spectrum channel object.
Definition: tv-spectrum-transmitter.h:134
ns3::TvSpectrumTransmitter
SpectrumPhy implementation that creates a customizable TV transmitter which transmits a PSD spectrum ...
Definition: tv-spectrum-transmitter.h:47
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
ns3::TvSpectrumTransmitter::StartRx
void StartRx(Ptr< SpectrumSignalParameters > params)
Notify the SpectrumPhy instance of an incoming signal.
Definition: tv-spectrum-transmitter.cc:175
ns3::TvSpectrumTransmitter::GetRxSpectrumModel
Ptr< const SpectrumModel > GetRxSpectrumModel() const
Definition: tv-spectrum-transmitter.cc:161
ns3::TvSpectrumTransmitter::m_antenna
Ptr< AntennaModel > m_antenna
Pointer to antenna model object.
Definition: tv-spectrum-transmitter.h:132
ns3::TvSpectrumTransmitter::SetChannel
void SetChannel(Ptr< SpectrumChannel > c)
Set the channel attached to this device.
Definition: tv-spectrum-transmitter.cc:126
ns3::TvSpectrumTransmitter::m_startingTime
Time m_startingTime
Timepoint after simulation begins that TV transmitter will begin transmitting.
Definition: tv-spectrum-transmitter.h:144
ns3::TvSpectrumTransmitter::TVTYPE_8VSB
@ TVTYPE_8VSB
Definition: tv-spectrum-transmitter.h:56
ns3::SpectrumPhy
Abstract base class for Spectrum-aware PHY layers.
Definition: spectrum-phy.h:46
ns3::TvSpectrumTransmitter::m_transmitDuration
Time m_transmitDuration
Length of time that TV transmitter will transmit for.
Definition: tv-spectrum-transmitter.h:145
ns3::TvSpectrumTransmitter::GetMobility
Ptr< MobilityModel > GetMobility() const
Get the associated MobilityModel instance.
Definition: tv-spectrum-transmitter.cc:147
ns3::TvSpectrumTransmitter::SetDevice
void SetDevice(Ptr< NetDevice > d)
Set the associated NetDevice instance.
Definition: tv-spectrum-transmitter.cc:140
ns3::TvSpectrumTransmitter::Stop
virtual void Stop()
Stops the TV Transmitter's transmission on the spectrum channel.
Definition: tv-spectrum-transmitter.cc:586
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
ns3::TvSpectrumTransmitter::TvType
TvType
types of TV transmitters: analog, digital 8-VSB, or digital COFDM
Definition: tv-spectrum-transmitter.h:54
ns3::TvSpectrumTransmitter::CreateTvPsd
virtual void CreateTvPsd()
Creates power spectral density (PSD) spectrum of the TV transmitter and sets it for transmission.
Definition: tv-spectrum-transmitter.cc:240
ns3::TvSpectrumTransmitter::~TvSpectrumTransmitter
virtual ~TvSpectrumTransmitter()
Definition: tv-spectrum-transmitter.cc:57
ns3::TvSpectrumTransmitter::GetTxPsd
Ptr< SpectrumValue > GetTxPsd() const
Get the power spectral density of the TV transmitter's signal.
Definition: tv-spectrum-transmitter.cc:554
ns3::TvSpectrumTransmitter::Start
virtual void Start()
Starts the TV Transmitter's transmission on the spectrum channel.
Definition: tv-spectrum-transmitter.cc:574
ns3::TvSpectrumTransmitter::TVTYPE_ANALOG
@ TVTYPE_ANALOG
Definition: tv-spectrum-transmitter.h:55
ns3::TvSpectrumTransmitter::m_netDevice
Ptr< NetDevice > m_netDevice
Pointer to net device object.
Definition: tv-spectrum-transmitter.h:133
ns3::TvSpectrumTransmitter::m_tvType
enum TvType m_tvType
Type of TV transmitter.
Definition: tv-spectrum-transmitter.h:139
ns3::TvSpectrumTransmitter::TVTYPE_COFDM
@ TVTYPE_COFDM
Definition: tv-spectrum-transmitter.h:57
ns3::TvSpectrumTransmitter::m_basePsd
double m_basePsd
Base power spectral density value (in dBm/Hz) of TV transmitter's signal.
Definition: tv-spectrum-transmitter.h:142
ns3::TvSpectrumTransmitter::m_channelBandwidth
double m_channelBandwidth
Bandwidth (in Hz) of TV transmitter's signal.
Definition: tv-spectrum-transmitter.h:141
ns3::TvSpectrumTransmitter::m_mobility
Ptr< MobilityModel > m_mobility
Pointer to mobility model object.
Definition: tv-spectrum-transmitter.h:131
ns3::TvSpectrumTransmitter::GetTypeId
static TypeId GetTypeId(void)
Register this type.
Definition: tv-spectrum-transmitter.cc:68
ns3::TvSpectrumTransmitter::GetDevice
Ptr< NetDevice > GetDevice() const
Get the associated NetDevice instance.
Definition: tv-spectrum-transmitter.cc:154