A Discrete-Event Network Simulator
API
multi-model-spectrum-channel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2009 CTTC
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Nicola Baldo <nbaldo@cttc.es>
18  */
19 
20 #ifndef MULTI_MODEL_SPECTRUM_CHANNEL_H
21 #define MULTI_MODEL_SPECTRUM_CHANNEL_H
22 
23 #include "spectrum-channel.h"
24 #include "spectrum-converter.h"
26 #include "spectrum-value.h"
27 
28 #include <ns3/propagation-delay-model.h>
29 
30 #include <map>
31 #include <set>
32 
33 namespace ns3
34 {
35 
40 typedef std::map<SpectrumModelUid_t, SpectrumConverter> SpectrumConverterMap_t;
41 
48 {
49  public:
55 
58 };
59 
64 typedef std::map<SpectrumModelUid_t, TxSpectrumModelInfo> TxSpectrumModelInfoMap_t;
65 
72 {
73  public:
79 
81  std::vector<Ptr<SpectrumPhy>> m_rxPhys;
82 };
83 
88 typedef std::map<SpectrumModelUid_t, RxSpectrumModelInfo> RxSpectrumModelInfoMap_t;
89 
104 {
105  public:
107 
112  static TypeId GetTypeId();
113 
114  // inherited from SpectrumChannel
115  void RemoveRx(Ptr<SpectrumPhy> phy) override;
116  void AddRx(Ptr<SpectrumPhy> phy) override;
118 
119  // inherited from Channel
120  std::size_t GetNDevices() const override;
121  Ptr<NetDevice> GetDevice(std::size_t i) const override;
122 
123  protected:
124  void DoDispose() override;
125 
126  private:
137  TxSpectrumModelInfoMap_t::const_iterator FindAndEventuallyAddTxSpectrumModel(
138  Ptr<const SpectrumModel> txSpectrumModel);
139 
147 
155 
161 
165  std::size_t m_numDevices;
166 };
167 
168 } // namespace ns3
169 
170 #endif /* MULTI_MODEL_SPECTRUM_CHANNEL_H */
This SpectrumChannel implementation can handle the presence of SpectrumPhy instances which can use di...
void RemoveRx(Ptr< SpectrumPhy > phy) override
Remove a SpectrumPhy from a channel.
Ptr< NetDevice > GetDevice(std::size_t i) const override
std::size_t GetNDevices() const override
void AddRx(Ptr< SpectrumPhy > phy) override
Add a SpectrumPhy to a channel, so it can receive packets.
TxSpectrumModelInfoMap_t m_txSpectrumModelInfoMap
Data structure holding, for each TX SpectrumModel, all the converters to any RX SpectrumModel,...
std::size_t m_numDevices
Number of devices connected to the channel.
void DoDispose() override
Destructor implementation.
void StartTx(Ptr< SpectrumSignalParameters > params) override
Used by attached PHY instances to transmit signals on the channel.
TxSpectrumModelInfoMap_t::const_iterator FindAndEventuallyAddTxSpectrumModel(Ptr< const SpectrumModel > txSpectrumModel)
This method checks if m_rxSpectrumModelInfoMap contains an entry for the given TX SpectrumModel.
static TypeId GetTypeId()
Get the type ID.
virtual void StartRx(Ptr< SpectrumSignalParameters > params, Ptr< SpectrumPhy > receiver)
Used internally to reschedule transmission after the propagation delay.
RxSpectrumModelInfoMap_t m_rxSpectrumModelInfoMap
Data structure holding, for each RX spectrum model, all the corresponding SpectrumPhy instances.
The Rx spectrum model information.
std::vector< Ptr< SpectrumPhy > > m_rxPhys
Container of the Rx Spectrum phy objects.
RxSpectrumModelInfo(Ptr< const SpectrumModel > rxSpectrumModel)
Constructor.
Ptr< const SpectrumModel > m_rxSpectrumModel
Rx Spectrum model.
Defines the interface for spectrum-aware channel implementations.
The Tx spectrum model information.
Ptr< const SpectrumModel > m_txSpectrumModel
Tx Spectrum model.
SpectrumConverterMap_t m_spectrumConverterMap
Spectrum converter.
TxSpectrumModelInfo(Ptr< const SpectrumModel > txSpectrumModel)
Constructor.
a unique identifier for an interface.
Definition: type-id.h:59
std::map< SpectrumModelUid_t, TxSpectrumModelInfo > TxSpectrumModelInfoMap_t
Container: SpectrumModelUid_t, TxSpectrumModelInfo.
std::map< SpectrumModelUid_t, SpectrumConverter > SpectrumConverterMap_t
Container: SpectrumModelUid_t, SpectrumConverter.
std::map< SpectrumModelUid_t, RxSpectrumModelInfo > RxSpectrumModelInfoMap_t
Container: SpectrumModelUid_t, RxSpectrumModelInfo.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
phy
Definition: third.py:89
params
Fit Fluctuating Two Ray model to the 3GPP TR 38.901 using the Anderson-Darling goodness-of-fit ##.