A Discrete-Event Network Simulator
API
spectrum-model.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 #ifndef SPECTRUM_MODEL_H
22 #define SPECTRUM_MODEL_H
23 
24 #include <ns3/simple-ref-count.h>
25 #include <vector>
26 
27 namespace ns3 {
28 
45 struct BandInfo
46 {
47  double fl;
48  double fc;
49  double fh;
50 };
51 
52 
54 typedef std::vector<BandInfo> Bands;
55 
57 typedef uint32_t SpectrumModelUid_t;
58 
66 class SpectrumModel : public SimpleRefCount<SpectrumModel>
67 {
68 public:
75  friend bool operator== (const SpectrumModel& lhs, const SpectrumModel& rhs);
76 
86  SpectrumModel (const std::vector<double>& centerFreqs);
87 
88 
95  SpectrumModel (const Bands& bands);
96 
104  SpectrumModel (Bands&& bands);
105 
110  size_t GetNumBands () const;
111 
112 
117  SpectrumModelUid_t GetUid () const;
118 
124  Bands::const_iterator Begin () const;
130  Bands::const_iterator End () const;
131 
138  bool IsOrthogonal (const SpectrumModel &other) const;
139 
140 private:
144 };
145 
146 
147 } // namespace ns3
148 
149 #endif /* SPECTRUM_MODEL_H */
ns3::SpectrumModel::m_uidCount
static SpectrumModelUid_t m_uidCount
counter to assign m_uids
Definition: spectrum-model.h:143
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::SimpleRefCount
A template-based reference counting class.
Definition: simple-ref-count.h:74
ns3::BandInfo
The building block of a SpectrumModel.
Definition: spectrum-model.h:46
ns3::BandInfo::fl
double fl
lower limit of subband
Definition: spectrum-model.h:47
ns3::SpectrumModel::End
Bands::const_iterator End() const
Const Iterator to the model Bands container end.
Definition: spectrum-model.cc:94
ns3::SpectrumModel::operator==
friend bool operator==(const SpectrumModel &lhs, const SpectrumModel &rhs)
Comparison operator.
Definition: spectrum-model.cc:34
ns3::SpectrumModel::m_uid
SpectrumModelUid_t m_uid
unique id for a given set of frequencies
Definition: spectrum-model.h:142
ns3::BandInfo::fc
double fc
center frequency
Definition: spectrum-model.h:48
ns3::SpectrumModel::GetNumBands
size_t GetNumBands() const
Definition: spectrum-model.cc:100
ns3::BandInfo::fh
double fh
upper limit of subband
Definition: spectrum-model.h:49
ns3::Bands
std::vector< BandInfo > Bands
Container of BandInfo.
Definition: spectrum-model.h:54
ns3::SpectrumModel::IsOrthogonal
bool IsOrthogonal(const SpectrumModel &other) const
Check if another SpectrumModels has bands orthogonal to our bands.
Definition: spectrum-model.cc:112
ns3::SpectrumModel::GetUid
SpectrumModelUid_t GetUid() const
Definition: spectrum-model.cc:106
ns3::SpectrumModel
Set of frequency values implementing the domain of the functions in the Function Space defined by Spe...
Definition: spectrum-model.h:67
ns3::SpectrumModelUid_t
uint32_t SpectrumModelUid_t
Uid for SpectrumModels.
Definition: spectrum-model.h:57
ns3::SpectrumModel::m_bands
Bands m_bands
Actual definition of frequency bands within this SpectrumModel.
Definition: spectrum-model.h:141
ns3::SpectrumModel::SpectrumModel
SpectrumModel(const std::vector< double > &centerFreqs)
This constructs a SpectrumModel based on a given set of frequencies, which is assumed to be sorted by...
Definition: spectrum-model.cc:41
ns3::SpectrumModel::Begin
Bands::const_iterator Begin() const
Const Iterator to the model Bands container start.
Definition: spectrum-model.cc:88