A Discrete-Event Network Simulator
API
ampdu-tag.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Authors: Ghada Badawy <gbadawy@gmail.com>
19  * Sébastien Deronne <sebastien.deronne@gmail.com>
20  */
21 
22 #include "ampdu-tag.h"
23 #include "ns3/uinteger.h"
24 
25 namespace ns3 {
26 
28 
29 TypeId
31 {
32  static TypeId tid = TypeId ("ns3::AmpduTag")
33  .SetParent<Tag> ()
34  .SetGroupName ("Wifi")
35  .AddConstructor<AmpduTag> ()
36  .AddAttribute ("AmpduExists", "The value that indicates that the packet contains an AMPDU",
37  UintegerValue (false),
39  MakeUintegerChecker<uint8_t> ())
40  ;
41  return tid;
42 }
43 
44 TypeId
46 {
47  return GetTypeId ();
48 }
49 
51  : m_ampdu (0),
52  m_nbOfMpdus (0),
53  m_duration (Seconds(0))
54 {
55 }
56 
57 void
58 AmpduTag::SetAmpdu (bool supported)
59 {
60  m_ampdu = supported;
61 }
62 
63 void
65 {
66  NS_ASSERT (nbofmpdus <= 64);
67  m_nbOfMpdus = nbofmpdus;
68 }
69 
70 void
72 {
74  m_duration = duration;
75 }
76 
77 uint32_t
79 {
80  return (2 + sizeof (Time));
81 }
82 
83 void
85 {
86  i.WriteU8 (m_ampdu);
87  i.WriteU8 (m_nbOfMpdus);
88  int64_t duration = m_duration.GetTimeStep ();
89  i.Write ((const uint8_t *)&duration, sizeof(int64_t));
90 }
91 
92 void
94 {
95  m_ampdu = i.ReadU8 ();
96  m_nbOfMpdus = i.ReadU8 ();
97  int64_t duration;
98  i.Read ((uint8_t *)&duration, 8);
99  m_duration = Time (duration);
100 }
101 
102 bool
104 {
105  return (m_ampdu == 1) ? true : false;
106 }
107 
108 uint8_t
110 {
111  return m_nbOfMpdus;
112 }
113 
114 Time
116 {
117  return m_duration;
118 }
119 
120 void
121 AmpduTag::Print (std::ostream &os) const
122 {
123  os << "A-MPDU exists=" << m_ampdu
124  << " Remaining number of MPDUs=" << m_nbOfMpdus
125  << " Remaining A-MPDU duration=" << m_duration;
126 }
127 
128 } //namespace ns3
void Write(const uint8_t *buffer, uint32_t size)
Definition: tag-buffer.cc:125
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
uint8_t GetRemainingNbOfMpdus(void) const
Definition: ampdu-tag.cc:109
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
void Print(std::ostream &os) const
Definition: ampdu-tag.cc:121
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:67
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1001
void(* Time)(Time oldValue, Time newValue)
TracedValue callback signature for Time.
Definition: nstime.h:719
bool GetAmpdu(void) const
Definition: ampdu-tag.cc:103
TAG_BUFFER_INLINE uint8_t ReadU8(void)
Definition: tag-buffer.h:195
uint32_t GetSerializedSize() const
Definition: ampdu-tag.cc:78
void SetAmpdu(bool supported)
Definition: ampdu-tag.cc:58
AmpduTag()
Create a AmpduTag with the default =0 no Ampdu.
Definition: ampdu-tag.cc:50
Hold an unsigned integer type.
Definition: uinteger.h:44
uint8_t m_nbOfMpdus
Remaining number of MPDUs in the A-MPDU.
Definition: ampdu-tag.h:96
The aim of the AmpduTag is to provide means for a MAC to specify that a packet includes A-MPDU since ...
Definition: ampdu-tag.h:36
tag a set of bytes in a packet
Definition: tag.h:36
Every class exported by the ns3 library is enclosed in the ns3 namespace.
int64_t GetTimeStep(void) const
Get the raw time value, in the current resolution unit.
Definition: nstime.h:377
TAG_BUFFER_INLINE void WriteU8(uint8_t v)
Definition: tag-buffer.h:172
TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: ampdu-tag.cc:45
void Deserialize(TagBuffer i)
Definition: ampdu-tag.cc:93
uint8_t m_ampdu
Flag whether it is an A-MPDU.
Definition: ampdu-tag.h:95
read and write tag data
Definition: tag-buffer.h:51
void Serialize(TagBuffer i) const
Definition: ampdu-tag.cc:84
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:993
void Read(uint8_t *buffer, uint32_t size)
Definition: tag-buffer.cc:176
static TypeId GetTypeId(void)
Get the type ID.
Definition: ampdu-tag.cc:30
void SetRemainingNbOfMpdus(uint8_t nbofmpdus)
Definition: ampdu-tag.cc:64
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: uinteger.h:45
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:914
Time GetRemainingAmpduDuration(void) const
Definition: ampdu-tag.cc:115
Time m_duration
Remaining duration of the A-MPDU in nanoseconds.
Definition: ampdu-tag.h:97
void SetRemainingAmpduDuration(Time duration)
Definition: ampdu-tag.cc:71