A Discrete-Event Network Simulator
API
spectrum-interference.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_INTERFERENCE_H
23 #define SPECTRUM_INTERFERENCE_H
24 
25 #include <ns3/object.h>
26 #include <ns3/packet.h>
27 #include <ns3/nstime.h>
28 #include <ns3/spectrum-value.h>
29 
30 namespace ns3 {
31 
32 
33 
34 
35 class SpectrumErrorModel;
36 
37 
38 
47 {
48 public:
50  virtual ~SpectrumInterference ();
51 
56  static TypeId GetTypeId (void);
57 
64 
72 
76  void AbortRx ();
77 
89  bool EndRx ();
90 
91 
100  void AddSignal (Ptr<const SpectrumValue> spd, const Time duration);
101 
109 
110 
111 protected:
112  void DoDispose ();
113 
114 private:
115 
130 
131  bool m_receiving;
132 
137 
143 
145 
147 
149 
150 
151 
152 };
153 
154 
155 
156 } // namespace ns3
157 
158 
159 
160 
161 
162 #endif /* SPECTRUM_INTERFERENCE_H */
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
bool m_receiving
True if in Rx status.
static TypeId GetTypeId(void)
Register this type.
void SetNoisePowerSpectralDensity(Ptr< const SpectrumValue > noisePsd)
Set the Noise Power Spectral Density.
void AddSignal(Ptr< const SpectrumValue > spd, const Time duration)
Notify that a new signal is being perceived in the medium.
void AbortRx()
Notify that the PHY has aborted RX.
Ptr< const SpectrumValue > m_noise
Noise spectral power density.
void StartRx(Ptr< const Packet > p, Ptr< const SpectrumValue > rxPsd)
Notify that the PHY is starting a RX attempt.
void DoDispose()
Destructor implementation.
Time m_lastChangeTime
the time of the last change in m_TotalPower
Ptr< SpectrumValue > m_allSignals
Stores the spectral power density of the sum of incoming signals; does not include noise...
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool EndRx()
Notify that the RX attempt has ended.
This class implements a gaussian interference model, i.e., all incoming signals are added to the tota...
Ptr< const SpectrumValue > m_rxSignal
Stores the power spectral density of the signal whose RX is being attempted.
Ptr< SpectrumErrorModel > m_errorModel
Error model.
void DoAddSignal(Ptr< const SpectrumValue > spd)
Adds a signal perceived in the medium.
void SetErrorModel(Ptr< SpectrumErrorModel > e)
Set the SpectrumErrorModel to be used.
void DoSubtractSignal(Ptr< const SpectrumValue > spd)
Removes a signal perceived in the medium.
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
void ConditionallyEvaluateChunk()
Evaluate a Chunk, depending on the Rx status and the last update time.