A Discrete-Event Network Simulator
API
ie-dot11s-prep.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008,2009 IITP RAS
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  * Author: Kirill Andreev <andreev@iitp.ru>
19  */
20 
21 #ifndef WIFI_PREP_INFORMATION_ELEMENT_H
22 #define WIFI_PREP_INFORMATION_ELEMENT_H
23 
24 #include "ns3/mac48-address.h"
25 #include "ns3/mesh-information-element-vector.h"
26 
27 namespace ns3 {
28 namespace dot11s {
34 {
35 public:
36  IePrep ();
37  ~IePrep ();
42  void SetFlags (uint8_t flags);
47  void SetHopcount (uint8_t hopcount);
52  void SetTtl (uint8_t ttl);
57  void SetDestinationAddress (Mac48Address dest_address);
62  void SetDestinationSeqNumber (uint32_t dest_seq_number);
67  void SetLifetime (uint32_t lifetime);
72  void SetMetric (uint32_t metric);
77  void SetOriginatorAddress (Mac48Address originator_address);
82  void SetOriginatorSeqNumber (uint32_t originator_seq_number);
83 
88  uint8_t GetFlags () const;
93  uint8_t GetHopcount () const;
98  uint32_t GetTtl () const;
108  uint32_t GetDestinationSeqNumber () const;
113  uint32_t GetLifetime () const;
118  uint32_t GetMetric () const;
128  uint32_t GetOriginatorSeqNumber () const;
129 
131  void DecrementTtl ();
136  void IncrementMetric (uint32_t metric);
137 
138  // Inherited from WifiInformationElement
139  virtual WifiInformationElementId ElementId () const;
140  virtual void SerializeInformationField (Buffer::Iterator i) const;
141  virtual uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length);
142  virtual uint8_t GetInformationFieldSize () const;
143  virtual void Print (std::ostream& os) const;
144 
145 private:
146  uint8_t m_flags;
147  uint8_t m_hopcount;
148  uint8_t m_ttl;
150  uint32_t m_destSeqNumber;
151  uint32_t m_lifetime;
152  uint32_t m_metric;
155 
162  friend bool operator== (const IePrep & a, const IePrep & b);
163 };
164 bool operator== (const IePrep & a, const IePrep & b);
165 std::ostream &operator << (std::ostream &os, const IePrep &prep);
166 } // namespace dot11s
167 } // namespace ns3
168 #endif
169 
ns3::dot11s::IePrep::GetMetric
uint32_t GetMetric() const
Get metric function.
Definition: ie-dot11s-prep.cc:115
ns3::dot11s::IePrep::GetTtl
uint32_t GetTtl() const
Get TTL function.
Definition: ie-dot11s-prep.cc:100
ns3::dot11s::IePrep::DecrementTtl
void DecrementTtl()
Decrement TTL function.
Definition: ie-dot11s-prep.cc:135
ns3::dot11s::IePrep::GetDestinationSeqNumber
uint32_t GetDestinationSeqNumber() const
Get destination sequence number function.
Definition: ie-dot11s-prep.cc:105
ns3::dot11s::operator==
bool operator==(const MeshHeader &a, const MeshHeader &b)
Definition: dot11s-mac-header.cc:172
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::dot11s::IePrep::m_metric
uint32_t m_metric
metric
Definition: ie-dot11s-prep.h:152
ns3::WifiInformationElement
Information element, as defined in 802.11-2007 standard.
Definition: wifi-information-element.h:234
ns3::Mac48Address
an EUI-48 address
Definition: mac48-address.h:44
ns3::dot11s::IePrep::ElementId
virtual WifiInformationElementId ElementId() const
Definition: ie-dot11s-prep.cc:40
ns3::WifiInformationElementId
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.
Definition: wifi-information-element.h:40
ns3::dot11s::IePrep::SetOriginatorAddress
void SetOriginatorAddress(Mac48Address originator_address)
Set originator address function.
Definition: ie-dot11s-prep.cc:75
ns3::dot11s::IePrep::GetInformationFieldSize
virtual uint8_t GetInformationFieldSize() const
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...
Definition: ie-dot11s-prep.cc:176
visualizer.core.start
def start()
Definition: core.py:1855
ns3::dot11s::IePrep::~IePrep
~IePrep()
Definition: ie-dot11s-prep.cc:30
ns3::dot11s::IePrep::m_originatorSeqNumber
uint32_t m_originatorSeqNumber
originator sequence number
Definition: ie-dot11s-prep.h:154
ns3::dot11s::IePrep::m_ttl
uint8_t m_ttl
TTL.
Definition: ie-dot11s-prep.h:148
ns3::dot11s::IePrep::GetFlags
uint8_t GetFlags() const
Get flags function.
Definition: ie-dot11s-prep.cc:90
ns3::dot11s::IePrep::DeserializeInformationField
virtual uint8_t DeserializeInformationField(Buffer::Iterator start, uint8_t length)
Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)
Definition: ie-dot11s-prep.cc:161
ns3::dot11s::IePrep::Print
virtual void Print(std::ostream &os) const
Generate human-readable form of IE.
Definition: ie-dot11s-prep.cc:190
ns3::dot11s::IePrep::SetDestinationAddress
void SetDestinationAddress(Mac48Address dest_address)
Set destination address function.
Definition: ie-dot11s-prep.cc:65
ns3::dot11s::IePrep::SetDestinationSeqNumber
void SetDestinationSeqNumber(uint32_t dest_seq_number)
Set destination sequence number function.
Definition: ie-dot11s-prep.cc:60
ns3::dot11s::IePrep::SetOriginatorSeqNumber
void SetOriginatorSeqNumber(uint32_t originator_seq_number)
Set originator sequence number function.
Definition: ie-dot11s-prep.cc:80
ns3::dot11s::IePrep::m_destinationAddress
Mac48Address m_destinationAddress
destination address
Definition: ie-dot11s-prep.h:149
ns3::dot11s::IePrep::IncrementMetric
void IncrementMetric(uint32_t metric)
Increment metric function.
Definition: ie-dot11s-prep.cc:142
ns3::Buffer::Iterator
iterator in a Buffer instance
Definition: buffer.h:99
ns3::dot11s::IePrep::m_flags
uint8_t m_flags
flags
Definition: ie-dot11s-prep.h:146
ns3::dot11s::IePrep::SetFlags
void SetFlags(uint8_t flags)
Set flags function.
Definition: ie-dot11s-prep.cc:45
ns3::dot11s::IePrep::m_lifetime
uint32_t m_lifetime
lifetime
Definition: ie-dot11s-prep.h:151
ns3::dot11s::IePrep::SetHopcount
void SetHopcount(uint8_t hopcount)
Set hop count function.
Definition: ie-dot11s-prep.cc:50
ns3::dot11s::IePrep::GetOriginatorSeqNumber
uint32_t GetOriginatorSeqNumber() const
Get originator sequence number.
Definition: ie-dot11s-prep.cc:125
ns3::dot11s::IePrep::m_originatorAddress
Mac48Address m_originatorAddress
originator address
Definition: ie-dot11s-prep.h:153
ns3::dot11s::IePrep::SetLifetime
void SetLifetime(uint32_t lifetime)
Set lifetime function.
Definition: ie-dot11s-prep.cc:85
ns3::dot11s::IePrep::GetOriginatorAddress
Mac48Address GetOriginatorAddress() const
Get originator address function.
Definition: ie-dot11s-prep.cc:120
ns3::dot11s::IePrep
See 7.3.2.97 of 802.11s draft 2.07.
Definition: ie-dot11s-prep.h:34
ns3::dot11s::IePrep::SerializeInformationField
virtual void SerializeInformationField(Buffer::Iterator i) const
Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
Definition: ie-dot11s-prep.cc:148
ns3::dot11s::IePrep::GetLifetime
uint32_t GetLifetime() const
Get lifetime function.
Definition: ie-dot11s-prep.cc:130
ns3::dot11s::IePrep::SetMetric
void SetMetric(uint32_t metric)
Set metric function.
Definition: ie-dot11s-prep.cc:70
ns3::dot11s::IePrep::m_destSeqNumber
uint32_t m_destSeqNumber
destination sequence number
Definition: ie-dot11s-prep.h:150
ns3::dot11s::IePrep::SetTtl
void SetTtl(uint8_t ttl)
Set TTL function.
Definition: ie-dot11s-prep.cc:55
ns3::dot11s::operator<<
std::ostream & operator<<(std::ostream &os, const IeBeaconTiming &a)
Definition: ie-dot11s-beacon-timing.cc:215
ns3::dot11s::IePrep::GetDestinationAddress
Mac48Address GetDestinationAddress() const
Get destination address function.
Definition: ie-dot11s-prep.cc:110
ns3::dot11s::IePrep::m_hopcount
uint8_t m_hopcount
hop count
Definition: ie-dot11s-prep.h:147
ns3::dot11s::IePrep::operator==
friend bool operator==(const IePrep &a, const IePrep &b)
equality operator
Definition: ie-dot11s-prep.cc:198
ns3::dot11s::IePrep::GetHopcount
uint8_t GetHopcount() const
Get hop count function.
Definition: ie-dot11s-prep.cc:95
ns3::dot11s::IePrep::IePrep
IePrep()
Definition: ie-dot11s-prep.cc:33