A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
spectrum-model.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 SPECTRUM_MODEL_H
21#define SPECTRUM_MODEL_H
22
23#include <ns3/simple-ref-count.h>
24
25#include <cstddef>
26#include <vector>
27
28namespace ns3
29{
30
53{
54 double fl;
55 double fc;
56 double fh;
57};
58
60typedef std::vector<BandInfo> Bands;
61
64
72class SpectrumModel : public SimpleRefCount<SpectrumModel>
73{
74 public:
81 friend bool operator==(const SpectrumModel& lhs, const SpectrumModel& rhs);
82
92 SpectrumModel(const std::vector<double>& centerFreqs);
93
100 SpectrumModel(const Bands& bands);
101
109 SpectrumModel(Bands&& bands);
110
115 size_t GetNumBands() const;
116
122
128 Bands::const_iterator Begin() const;
134 Bands::const_iterator End() const;
135
142 bool IsOrthogonal(const SpectrumModel& other) const;
143
144 private:
148};
149
150} // namespace ns3
151
152#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
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