EMANE  1.2.1
slotter.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 - 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 EMANEMODELSTDMASLOTTER_HEADER_
34 #define EMANEMODELSTDMASLOTTER_HEADER_
35 
36 #include "emane/types.h"
37 
38 namespace EMANE
39 {
40  namespace Models
41  {
42  namespace TDMA
43  {
49  class Slotter
50  {
51  public:
52  Slotter();
53 
54  void reset(const EMANE::Microseconds & slotSizeMicroseconds,
55  std::uint64_t u32SlotsPerFrame,
56  std::uint64_t u32FramesPerMultiFrame);
57 
58  TimePoint getMultiFrameTime(std::uint64_t u64MultiFrameIndex) const;
59 
60  TimePoint getFrameTime(std::uint64_t u64FrameIndex) const;
61 
62  TimePoint getSlotTime(std::uint64_t u64SlotIndex) const;
63 
64  std::tuple<std::uint64_t,std::uint64_t,std::uint64_t>
65  getAbsoluteIndex(const EMANE::TimePoint & timePoint) const;
66 
67  std::tuple<std::uint32_t,std::uint32_t>
68  getRelativeIndex(std::uint64_t u64SlotIndex) const;
69 
70  private:
71  std::uint64_t u64SlotSizeMicroseconds_;
72  std::uint64_t u32SlotsPerFrame_;
73  std::uint64_t u32FramesPerMultiFrame_;
74 
75  };
76  }
77  }
78 }
79 
80 #include "slotter.inl"
81 
82 #endif // EMANEMODELSTDMASLOTTER_HEADER_
Helper class used to manipulate slot structure elements.
Definition: slotter.h:49
TimePoint getMultiFrameTime(std::uint64_t u64MultiFrameIndex) const
Definition: slotter.inl:51
std::tuple< std::uint32_t, std::uint32_t > getRelativeIndex(std::uint64_t u64SlotIndex) const
Definition: slotter.inl:91
TimePoint getFrameTime(std::uint64_t u64FrameIndex) const
Definition: slotter.inl:60
TimePoint getSlotTime(std::uint64_t u64SlotIndex) const
Definition: slotter.inl:68
void reset(const EMANE::Microseconds &slotSizeMicroseconds, std::uint64_t u32SlotsPerFrame, std::uint64_t u32FramesPerMultiFrame)
Definition: slotter.inl:40
std::chrono::microseconds Microseconds
Definition: types.h:45
std::tuple< std::uint64_t, std::uint64_t, std::uint64_t > getAbsoluteIndex(const EMANE::TimePoint &timePoint) const
Definition: slotter.inl:76
Clock::time_point TimePoint
Definition: types.h:50
Definition: agent.h:43