EMANE  1.2.1
spectrumserviceprovider.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014 - Adjacent Link LLC, Bridgewater, New Jersey
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * * Neither the name of Adjacent Link LLC nor the names of its
16  * contributors may be used to endorse or promote products derived
17  * from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef EMANESPECTRUMSERVICEPROVIDER_HEADER_
34 #define EMANESPECTRUMSERVICEPROVIDER_HEADER_
35 
36 #include "emane/types.h"
37 
38 #include <set>
39 #include <vector>
40 #include <tuple>
41 
42 namespace EMANE
43 {
44  using FrequencySet = std::set<std::uint64_t>;
45 
62  using SpectrumWindow = std::tuple<std::vector<double>,TimePoint,Microseconds,double,bool>;
63 
74  {
75  public:
80 
81 
87  virtual FrequencySet getFrequencies() const = 0;
88 
94  virtual double getReceiverSensitivitydBm() const = 0;
95 
129  virtual SpectrumWindow request(std::uint64_t u64FrequencyHz,
130  const Microseconds & duration = Microseconds::zero(),
131  const TimePoint & startTime = TimePoint::min()) const = 0;
132 
133  protected:
134  SpectrumServiceProvider() = default;
135  };
136 }
137 
138 #endif //EMANESPECTRUMSERVICEPROVIDER_HEADER_
139 
std::tuple< std::vector< double >, TimePoint, Microseconds, double, bool > SpectrumWindow
virtual double getReceiverSensitivitydBm() const =0
The SpectrumServiceProvider interface provides an API to request noise window information.
std::set< std::uint64_t > FrequencySet
std::chrono::microseconds Microseconds
Definition: types.h:45
virtual FrequencySet getFrequencies() const =0
Clock::time_point TimePoint
Definition: types.h:50
virtual SpectrumWindow request(std::uint64_t u64FrequencyHz, const Microseconds &duration=Microseconds::zero(), const TimePoint &startTime=TimePoint::min()) const =0
Definition: agent.h:43