A Discrete-Event Network Simulator
API
wifi-phy-tag.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 CTTC
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: Nicola Baldo <nbaldo@cttc.es>
19  */
20 
21 #ifndef WIFI_PHY_TAG_H
22 #define WIFI_PHY_TAG_H
23 
24 #include "ns3/tag.h"
25 #include "wifi-phy-common.h"
26 #include "wifi-mode.h"
27 
28 namespace ns3 {
29 
36 class WifiPhyTag : public Tag
37 {
38 public:
43  static TypeId GetTypeId (void);
44  TypeId GetInstanceTypeId (void) const;
45 
49  WifiPhyTag ();
56  WifiPhyTag (WifiPreamble preamble, WifiModulationClass modulation, uint8_t frameComplete);
61  WifiPreamble GetPreambleType (void) const;
71  uint8_t GetFrameComplete (void) const;
72 
73  // From class Tag
74  uint32_t GetSerializedSize (void) const;
75  void Serialize (TagBuffer i) const;
76  void Deserialize (TagBuffer i);
77  void Print (std::ostream &os) const;
78 
79 
80 private:
83  uint8_t m_frameComplete;
84 };
85 
86 } // namespace ns3
87 
88 #endif /* WIFI_PHY_TAG_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::WifiPhyTag::GetFrameComplete
uint8_t GetFrameComplete(void) const
Getter for frameComplete parameter.
Definition: wifi-phy-tag.cc:92
ns3::WifiPhyTag::m_frameComplete
uint8_t m_frameComplete
Used to indicate that TX stopped sending before the end of the frame.
Definition: wifi-phy-tag.h:83
ns3::WifiPhyTag::GetInstanceTypeId
TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: wifi-phy-tag.cc:35
ns3::WifiPhyTag::Print
void Print(std::ostream &os) const
Definition: wifi-phy-tag.cc:63
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::WifiPhyTag::WifiPhyTag
WifiPhyTag()
Constructor.
Definition: wifi-phy-tag.cc:68
ns3::WifiPhyTag
Tag for WifiTxVector and WifiPreamble information to be embedded in outgoing transmissions as a Packe...
Definition: wifi-phy-tag.h:37
ns3::WifiPhyTag::Deserialize
void Deserialize(TagBuffer i)
Definition: wifi-phy-tag.cc:55
wifi-phy-common.h
Declaration of the following enums:
ns3::WifiPhyTag::m_modulation
WifiModulationClass m_modulation
modulation used for transmission
Definition: wifi-phy-tag.h:82
ns3::Tag
tag a set of bytes in a packet
Definition: tag.h:37
ns3::WifiPhyTag::Serialize
void Serialize(TagBuffer i) const
Definition: wifi-phy-tag.cc:47
ns3::WifiPhyTag::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: wifi-phy-tag.cc:26
ns3::WifiPhyTag::GetModulation
WifiModulationClass GetModulation(void) const
Getter for modulation parameter.
Definition: wifi-phy-tag.cc:86
wifi-mode.h
ns3::WifiPhyTag::GetPreambleType
WifiPreamble GetPreambleType(void) const
Getter for preamble parameter.
Definition: wifi-phy-tag.cc:80
ns3::WifiPhyTag::m_preamble
WifiPreamble m_preamble
preamble type
Definition: wifi-phy-tag.h:81
ns3::WifiPreamble
WifiPreamble
The type of preamble to be used by an IEEE 802.11 transmission.
Definition: wifi-phy-common.h:63
ns3::WifiPhyTag::GetSerializedSize
uint32_t GetSerializedSize(void) const
Definition: wifi-phy-tag.cc:41
ns3::TagBuffer
read and write tag data
Definition: tag-buffer.h:52
ns3::WifiModulationClass
WifiModulationClass
This enumeration defines the modulation classes per (Table 10-6 "Modulation classes"; IEEE 802....
Definition: wifi-phy-common.h:117