EMANE  1.2.1
frequencysegment.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 EMANEFREQUENCYSEGMENT_HEADER_
34 #define EMANEFREQUENCYSEGMENT_HEADER_
35 
36 #include <cstdint>
37 #include <list>
38 
39 namespace EMANE
40 {
50  {
51  public:
59  FrequencySegment(std::uint64_t u64FrequencyHz,
60  const Microseconds & durationMicroseconds,
61  const Microseconds & offsetMicroseconds = Microseconds::zero());
62 
63 
73  FrequencySegment(std::uint64_t u64FrequencyHz,
74  double dPowerdBm,
75  const Microseconds & durationMicroseconds,
76  const Microseconds & offsetMicroseconds = Microseconds::zero());
77 
85  double dRxPowerdBm);
86 
91  FrequencySegment(const FrequencySegment & rhs) = default;
92 
98  std::uint64_t getFrequencyHz() const;
99 
105  const Microseconds & getOffset() const;
106 
112  const Microseconds & getDuration() const;
113 
119  double getRxPowerdBm() const;
120 
126  std::pair<double,bool> getPowerdBm() const;
127 
128  private:
129  std::uint64_t u64FrequencyHz_;
130  Microseconds durationMicroseconds_;
131  Microseconds offsetMicroseconds_;
132  double dPowerdBm_;
133  bool bHasPower_;
134  };
135 
136  using FrequencySegments = std::list<FrequencySegment>;
137 }
138 
140 
141 #endif // EMANEFREQUENCYSEGMENT_HEADER_
Holds the frequency, offset and duration of a frequency segment.
std::pair< double, bool > getPowerdBm() const
const Microseconds & getDuration() const
std::uint64_t getFrequencyHz() const
std::chrono::microseconds Microseconds
Definition: types.h:45
const Microseconds & getOffset() const
std::list< FrequencySegment > FrequencySegments
FrequencySegment(std::uint64_t u64FrequencyHz, const Microseconds &durationMicroseconds, const Microseconds &offsetMicroseconds=Microseconds::zero())
Definition: agent.h:43