A Discrete-Event Network Simulator
API
dsss-parameter-set.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2016 S├ębastien Deronne
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: S├ębastien Deronne <sebastien.deronne@gmail.com>
19  */
20 
21 #ifndef DSSS_PARAMETER_SET_H
22 #define DSSS_PARAMETER_SET_H
23 
24 #include <stdint.h>
25 #include <ostream>
26 #include "ns3/buffer.h"
27 #include "ns3/wifi-information-element.h"
28 
29 namespace ns3 {
30 
38 {
39 public:
41  void SetDsssSupported (uint8_t DsssSupported);
42 
48  void SetCurrentChannel (uint8_t currentChannel);
49 
50  /*
51  * Return the Current Channel field in the DsssParameterSet information element.
52  *
53  * \return the Current Channel field in the DsssParameterSet information element
54  */
55  uint8_t GetCurrentChannel (void) const;
56 
58  uint8_t GetInformationFieldSize () const;
60  uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length);
61 
78  uint16_t GetSerializedSize () const;
79 
80 private:
82 
83  //This is used to decide whether this element should be added to the frame or not
85 };
86 
87 std::ostream &operator << (std::ostream &os, const DsssParameterSet &dsssParameterSet);
88 std::istream &operator >> (std::istream &is, DsssParameterSet &dsssParameterSet);
89 
91 
92 } //namespace ns3
93 
94 #endif /* DSSS_PARAMETER_SET_H */
std::istream & operator>>(std::istream &is, Angles &a)
initialize a struct Angles from input
Definition: angles.cc:48
uint8_t GetInformationFieldSize() const
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...
def start()
Definition: core.py:1482
uint8_t GetCurrentChannel(void) const
uint16_t GetSerializedSize() const
Return the serialized size of this DSSS Parameter Set.
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...
WifiInformationElementId ElementId() const
Own unique Element ID.
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) ...
void SerializeInformationField(Buffer::Iterator start) const
Serialize information (i.e., the body of the IE, not including the Element ID and length octets) ...
void SetCurrentChannel(uint8_t currentChannel)
Set the Current Channel field in the DsssParameterSet information element.
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:42
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SetDsssSupported(uint8_t DsssSupported)
The DSSS Parameter SetThis class knows how to serialise and deserialise the DSSS Parameter Set...
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.
#define ATTRIBUTE_HELPER_HEADER(type)
Declare the attribute value, accessor and checkers for class type.
Buffer::Iterator Serialize(Buffer::Iterator start) const
This information element is a bit special in that it is only included if the STA does support DSSS...