A Discrete-Event Network Simulator
API
ssid.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2006 INRIA
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef SSID_H
21 #define SSID_H
22 
23 #include <stdint.h>
24 #include "ns3/buffer.h"
25 #include "ns3/attribute-helper.h"
26 #include "ns3/wifi-information-element.h"
27 
28 namespace ns3 {
29 
38 {
39 public:
40  // broadcast ssid
41  Ssid ();
47  Ssid (std::string s);
54  Ssid (char const ssid[32], uint8_t length);
55 
63  bool IsEqual (const Ssid& o) const;
70  bool IsBroadcast (void) const;
71 
77  char* PeekString (void) const;
78 
80  uint8_t GetInformationFieldSize () const;
83  uint8_t length);
84 
85 private:
86  uint8_t m_ssid[33];
87  uint8_t m_length;
88 };
89 
90 std::ostream &operator << (std::ostream &os, const Ssid &ssid);
91 std::istream &operator >> (std::istream &is, Ssid &ssid);
92 
94 
95 } // namespace ns3
96 
97 #endif /* SSID_H */
std::istream & operator>>(std::istream &is, Angles &a)
initialize a struct Angles from input
Definition: angles.cc:48
uint8_t m_ssid[33]
Raw SSID value.
Definition: ssid.h:86
def start()
Definition: core.py:1482
bool IsBroadcast(void) const
Check if the SSID is broadcast.
Definition: ssid.cc:85
bool IsEqual(const Ssid &o) const
Check if the two SSIDs are equal.
Definition: ssid.cc:69
Ssid()
Definition: ssid.cc:25
iterator in a Buffer instance
Definition: buffer.h:98
Information element, as defined in 802.11-2007 standardThe IEEE 802.11 standard includes the notion o...
uint8_t GetInformationFieldSize() const
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...
Definition: ssid.cc:109
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:42
char * PeekString(void) const
Peek the SSID.
Definition: ssid.cc:95
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SerializeInformationField(Buffer::Iterator start) const
Serialize information (i.e., the body of the IE, not including the Element ID and length octets) ...
Definition: ssid.cc:115
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:37
WifiInformationElementId ElementId() const
Own unique Element ID.
Definition: ssid.cc:103
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.
uint8_t m_length
Length of the SSID.
Definition: ssid.h:87
#define ATTRIBUTE_HELPER_HEADER(type)
Declare the attribute value, accessor and checkers for class type.
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: ssid.cc:121