A Discrete-Event Network Simulator
API
spectrum-channel.cc
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 #include <ns3/log.h>
22 #include <ns3/double.h>
23 #include <ns3/pointer.h>
24 
25 #include "spectrum-channel.h"
26 
27 
28 namespace ns3 {
29 
30 NS_LOG_COMPONENT_DEFINE ("SpectrumChannel");
31 
32 NS_OBJECT_ENSURE_REGISTERED (SpectrumChannel);
33 
35 {
36  NS_LOG_FUNCTION (this);
37 }
38 
40 {
41 }
42 
43 void
45 {
46  NS_LOG_FUNCTION (this);
50 }
51 
52 TypeId
54 {
55  static TypeId tid = TypeId ("ns3::SpectrumChannel")
56  .SetParent<Channel> ()
57  .SetGroupName ("Spectrum")
58  .AddAttribute ("MaxLossDb",
59  "If a single-frequency PropagationLossModel is used, "
60  "this value represents the maximum loss in dB for which "
61  "transmissions will be passed to the receiving PHY. "
62  "Signals for which the PropagationLossModel returns "
63  "a loss bigger than this value will not be propagated "
64  "to the receiver. This parameter is to be used to reduce "
65  "the computational load by not propagating signals "
66  "that are far beyond the interference range. Note that "
67  "the default value corresponds to considering all signals "
68  "for reception. Tune this value with care. ",
69  DoubleValue (1.0e9),
71  MakeDoubleChecker<double> ())
72 
73  .AddAttribute ("PropagationLossModel",
74  "A pointer to the propagation loss model attached to this channel.",
75  PointerValue (0),
77  MakePointerChecker<PropagationLossModel> ())
78 
79  .AddTraceSource ("Gain",
80  "This trace is fired whenever a new path loss value "
81  "is calculated. The parameters to this trace are : "
82  "Pointer to the mobility model of the transmitter"
83  "Pointer to the mobility model of the receiver"
84  "Tx antenna gain"
85  "Rx antenna gain"
86  "Propagation gain"
87  "Pathloss",
89  "ns3::SpectrumChannel::GainTracedCallback")
90 
91  .AddTraceSource ("PathLoss",
92  "This trace is fired whenever a new path loss value "
93  "is calculated. The first and second parameters "
94  "to the trace are pointers respectively to the TX and "
95  "RX SpectrumPhy instances, whereas the third parameters "
96  "is the loss value in dB. Note that the loss value "
97  "reported by this trace is the single-frequency loss "
98  "value obtained by evaluating only the TX and RX "
99  "AntennaModels and the PropagationLossModel. "
100  "In particular, note that SpectrumPropagationLossModel "
101  "(even if present) is never used to evaluate the "
102  "loss value reported in this trace. ",
104  "ns3::SpectrumChannel::LossTracedCallback")
105 
106  .AddTraceSource ("TxSigParams",
107  "This trace is fired whenever a signal is transmitted."
108  "The sole parameter is a pointer to a copy of the "
109  "SpectrumSignalParameters provided by the transmitter.",
111  "ns3::SpectrumChannel::SignalParametersTracedCallback")
112  ;
113  return tid;
114 }
115 
116 void
118 {
119  NS_LOG_FUNCTION (this << loss);
120  if (m_propagationLoss)
121  {
122  loss->SetNext (m_propagationLoss);
123  }
124  m_propagationLoss = loss;
125 }
126 
127 void
129 {
130  NS_LOG_FUNCTION (this << loss);
132  {
133  loss->SetNext (m_spectrumPropagationLoss);
134  }
136 }
137 
138 void
140 {
142  m_propagationDelay = delay;
143 }
144 
147 {
148  NS_LOG_FUNCTION (this);
150 }
151 
154 {
155  return m_propagationLoss;
156 }
157 
158 
159 } // namespace
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
virtual ~SpectrumChannel()
destructor
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
void SetNext(Ptr< PropagationLossModel > next)
Enables a chain of loss models to act on the signal.
TracedCallback< Ptr< const SpectrumPhy >, Ptr< const SpectrumPhy >, double > m_pathLossTrace
The PathLoss trace source.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:67
double m_maxLossDb
Maximum loss [dB].
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
Abstract Channel Base Class.
Definition: channel.h:43
void AddPropagationLossModel(Ptr< PropagationLossModel > loss)
Add the single-frequency propagation loss model to be used.
void AddSpectrumPropagationLossModel(Ptr< SpectrumPropagationLossModel > loss)
Add the frequency-dependent propagation loss model to be used.
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Ptr< const AttributeAccessor > MakePointerAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: pointer.h:227
static TypeId GetTypeId(void)
Get the type ID.
Ptr< SpectrumPropagationLossModel > m_spectrumPropagationLoss
Frequency-dependent propagation loss model to be used with this channel.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Hold objects of type Ptr<T>.
Definition: pointer.h:36
SpectrumChannel()
constructor
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: double.h:42
Ptr< PropagationLossModel > m_propagationLoss
Single-frequency propagation loss model to be used with this channel.
TracedCallback< Ptr< SpectrumSignalParameters > > m_txSigParamsTrace
Traced callback for SpectrumSignalParameters in StartTx requests.
void SetPropagationDelayModel(Ptr< PropagationDelayModel > delay)
Set the propagation delay model to be used.
Ptr< PropagationDelayModel > m_propagationDelay
Propagation delay model to be used with this channel.
This class can be used to hold variables of floating point type such as &#39;double&#39; or &#39;float&#39;...
Definition: double.h:41
a unique identifier for an interface.
Definition: type-id.h:58
TracedCallback< Ptr< const MobilityModel >, Ptr< const MobilityModel >, double, double, double, double > m_gainTrace
The Gain trace source.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:923
Ptr< PropagationLossModel > GetPropagationLossModel(void)
Get the propagation loss model.
virtual void DoDispose(void)
Destructor implementation.
Ptr< SpectrumPropagationLossModel > GetSpectrumPropagationLossModel(void)
Get the frequency-dependent propagation loss model.