A Discrete-Event Network Simulator
API
spectrum-channel.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 
22 #ifndef SPECTRUM_CHANNEL_H
23 #define SPECTRUM_CHANNEL_H
24 
25 #include <ns3/object.h>
26 #include <ns3/nstime.h>
27 #include <ns3/channel.h>
28 #include <ns3/spectrum-signal-parameters.h>
29 #include <ns3/spectrum-propagation-loss-model.h>
30 #include <ns3/phased-array-spectrum-propagation-loss-model.h>
31 #include <ns3/propagation-delay-model.h>
32 #include <ns3/propagation-loss-model.h>
33 #include <ns3/spectrum-phy.h>
34 #include <ns3/traced-callback.h>
35 #include <ns3/mobility-model.h>
36 
37 namespace ns3 {
38 
39 
40 class PacketBurst;
41 class SpectrumValue;
42 
49 class SpectrumChannel : public Channel
50 {
51 public:
52 
57  SpectrumChannel ();
62  virtual ~SpectrumChannel ();
63 
64  // inherited from Object
65  virtual void DoDispose (void);
66 
71  static TypeId GetTypeId (void);
72 
80 
86 
93 
99 
105 
112 
118 
124  virtual void StartTx (Ptr<SpectrumSignalParameters> params) = 0;
125 
139  virtual void RemoveRx (Ptr<SpectrumPhy> phy) = 0;
140 
156  virtual void AddRx (Ptr<SpectrumPhy> phy) = 0;
157 
165  typedef void (* LossTracedCallback)
167  double lossDb);
178  typedef void (* GainTracedCallback)
179  (Ptr<const MobilityModel> txMobility, Ptr<const MobilityModel> rxMobility,
180  double txAntennaGain, double rxAntennaGain,
181  double propagationGain, double pathloss);
188 
189 protected:
190 
196 
203 
208 
214  double m_maxLossDb;
215 
220 
225 
230 
235 
236 
237 };
238 
239 
240 }
241 
242 
243 #endif /* SPECTRUM_CHANNEL_H */
Abstract Channel Base Class.
Definition: channel.h:44
Defines the interface for spectrum-aware channel implementations.
void AddPropagationLossModel(Ptr< PropagationLossModel > loss)
Add the single-frequency propagation loss model to be used.
Ptr< PropagationLossModel > GetPropagationLossModel(void)
Get the propagation loss model.
TracedCallback< Ptr< const SpectrumPhy >, Ptr< const SpectrumPhy >, double > m_pathLossTrace
The PathLoss trace source.
TracedCallback< Ptr< SpectrumSignalParameters > > m_txSigParamsTrace
Traced callback for SpectrumSignalParameters in StartTx requests.
virtual void RemoveRx(Ptr< SpectrumPhy > phy)=0
Remove a SpectrumPhy from a channel.
virtual void StartTx(Ptr< SpectrumSignalParameters > params)=0
Used by attached PHY instances to transmit signals on the channel.
void AddSpectrumPropagationLossModel(Ptr< SpectrumPropagationLossModel > loss)
Add the frequency-dependent propagation loss model to be used.
SpectrumChannel()
constructor
void(* LossTracedCallback)(Ptr< const SpectrumPhy > txPhy, Ptr< const SpectrumPhy > rxPhy, double lossDb)
TracedCallback signature for path loss calculation events.
virtual ~SpectrumChannel()
destructor
Ptr< PropagationDelayModel > m_propagationDelay
Propagation delay model to be used with this channel.
virtual void DoDispose(void)
Destructor implementation.
Ptr< PhasedArraySpectrumPropagationLossModel > GetPhasedArraySpectrumPropagationLossModel(void)
Get the frequency-dependent propagation loss model that is compatible with the phased antenna arrays ...
static TypeId GetTypeId(void)
Get the type ID.
Ptr< SpectrumPropagationLossModel > m_spectrumPropagationLoss
Frequency-dependent propagation loss model to be used with this channel.
Ptr< PhasedArraySpectrumPropagationLossModel > m_phasedArraySpectrumPropagationLoss
Frequency-dependent propagation loss model to be used with this channel.
TracedCallback< Ptr< const MobilityModel >, Ptr< const MobilityModel >, double, double, double, double > m_gainTrace
The Gain trace source.
void(* GainTracedCallback)(Ptr< const MobilityModel > txMobility, Ptr< const MobilityModel > rxMobility, double txAntennaGain, double rxAntennaGain, double propagationGain, double pathloss)
TracedCallback signature for path loss calculation events.
Ptr< PropagationLossModel > m_propagationLoss
Single-frequency propagation loss model to be used with this channel.
virtual void AddRx(Ptr< SpectrumPhy > phy)=0
Add a SpectrumPhy to a channel, so it can receive packets.
void(* SignalParametersTracedCallback)(Ptr< SpectrumSignalParameters > params)
TracedCallback signature for Ptr<const SpectrumSignalParameters>.
void SetPropagationDelayModel(Ptr< PropagationDelayModel > delay)
Set the propagation delay model to be used.
Ptr< SpectrumPropagationLossModel > GetSpectrumPropagationLossModel(void)
Get the frequency-dependent propagation loss model.
double m_maxLossDb
Maximum loss [dB].
void AddPhasedArraySpectrumPropagationLossModel(Ptr< PhasedArraySpectrumPropagationLossModel > loss)
Add the frequency-dependent propagation loss model that is compapatible with the phased antenna array...
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.
phy
Definition: third.py:93