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 
50 struct BandInfo
51 {
52  double fl;
53  double fc;
54  double fh;
55 };
56 
57 
59 typedef std::vector<BandInfo> Bands;
60 
62 typedef uint32_t SpectrumModelUid_t;
63 
71 class SpectrumModel : public SimpleRefCount<SpectrumModel>
72 {
73 public:
80  friend bool operator== (const SpectrumModel& lhs, const SpectrumModel& rhs);
81 
91  SpectrumModel (const std::vector<double>& centerFreqs);
92 
93 
100  SpectrumModel (const Bands& bands);
101 
109  SpectrumModel (Bands&& bands);
110 
115  size_t GetNumBands () const;
116 
117 
122  SpectrumModelUid_t GetUid () const;
123 
129  Bands::const_iterator Begin () const;
135  Bands::const_iterator End () const;
136 
143  bool IsOrthogonal (const SpectrumModel &other) const;
144 
145 private:
149 };
150 
151 
152 } // namespace ns3
153 
154 #endif /* SPECTRUM_MODEL_H */
A template-based reference counting class.
Set of frequency values implementing the domain of the functions in the Function Space defined by Spe...
friend bool operator==(const SpectrumModel &lhs, const SpectrumModel &rhs)
Comparison operator.
bool IsOrthogonal(const SpectrumModel &other) const
Check if another SpectrumModels has bands orthogonal to our bands.
static SpectrumModelUid_t m_uidCount
counter to assign m_uids
SpectrumModelUid_t m_uid
unique id for a given set of frequencies
SpectrumModel(const std::vector< double > &centerFreqs)
This constructs a SpectrumModel based on a given set of frequencies, which is assumed to be sorted by...
Bands::const_iterator End() const
Const Iterator to the model Bands container end.
size_t GetNumBands() const
Bands::const_iterator Begin() const
Const Iterator to the model Bands container start.
SpectrumModelUid_t GetUid() const
Bands m_bands
Actual definition of frequency bands within this SpectrumModel.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::vector< BandInfo > Bands
Container of BandInfo.
uint32_t SpectrumModelUid_t
Uid for SpectrumModels.
The building block of a SpectrumModel.
double fc
center frequency
double fl
lower limit of subband
double fh
upper limit of subband