EMANE  1.2.1
neighbor2hopentry.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013 - Adjacent Link LLC, Bridgewater, New Jersey
3  * Copyright (c) 2010 - DRS CenGen, LLC, Columbia, Maryland
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  * * Neither the name of DRS CenGen, LLC nor the names of its
17  * contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef EMANEMODELSIEEE802ABGNEIGHBOR2HOPENTRY_HEADER_
35 #define EMANEMODELSIEEE802ABGNEIGHBOR2HOPENTRY_HEADER_
36 
37 
38 #include "emane/types.h"
39 
40 namespace EMANE
41  {
42  namespace Models
43  {
44  namespace IEEE80211ABG
45  {
54  {
55  public:
63 
72 
73 
83  void updateChannelActivity(const Microseconds & utilizationMicroseconds,
84  const TimePoint & activityTime,
85  size_t numPackets = 1);
86 
87 
93  void resetUtilization();
94 
103 
111  size_t getNumberOfPackets() const;
112 
113  private:
119  struct Utilization
120  {
121  Microseconds totalUtilizationMicroseconds_;
122 
123  size_t totalNumPackets_;
124 
125  Utilization() :
126  totalUtilizationMicroseconds_{},
127  totalNumPackets_{}
128  { }
129 
130  void reset()
131  {
132  totalUtilizationMicroseconds_ = Microseconds::zero();
133 
134  totalNumPackets_ = 0;
135  }
136 
137  void update(size_t numPackets, const Microseconds & utilizationMicroseconds)
138  {
139  totalNumPackets_ += numPackets;
140 
141  totalUtilizationMicroseconds_ += utilizationMicroseconds;
142  }
143  };
144 
145  TimePoint lastActivityTime_;
146 
147  Utilization utilization_;
148  };
149  }
150  }
151 }
152 #endif //EMANEMODELSIEEE802ABGNEIGHBOR2HOPENTRY_HEADER_
void updateChannelActivity(const Microseconds &utilizationMicroseconds, const TimePoint &activityTime, size_t numPackets=1)
std::chrono::microseconds Microseconds
Definition: types.h:45
Defines a 2 hop nbr and its bandwidth utilization.
Clock::time_point TimePoint
Definition: types.h:50
Definition: agent.h:43