src/wifi/model/wifi-information-element.h
changeset 7139 79dd02ed46ec
parent 6852 8f1a53d3f6ca
child 10139 17a71cd49da3
equal deleted inserted replaced
7138:90f585e0fcea 7139:79dd02ed46ec
    21 #ifndef WIFI_INFORMATION_ELEMENT_H
    21 #ifndef WIFI_INFORMATION_ELEMENT_H
    22 #define WIFI_INFORMATION_ELEMENT_H
    22 #define WIFI_INFORMATION_ELEMENT_H
    23 
    23 
    24 #include "ns3/header.h"
    24 #include "ns3/header.h"
    25 #include "ns3/simple-ref-count.h"
    25 #include "ns3/simple-ref-count.h"
    26 
       
    27 /**
       
    28  * \ingroup wifi
       
    29  *
       
    30  * \subsection wifi_ie Information Elements
       
    31  *
       
    32  * The IEEE 802.11 standard includes the notion of Information
       
    33  * Elements, which are encodings of management information to be
       
    34  * communicated between STAs in the payload of various frames of type
       
    35  * Management. Information Elements (IEs) have a common format, each
       
    36  * starting with a single octet - the Element ID, which indicates the
       
    37  * specific type of IE (a type to represent the options here is
       
    38  * defined as WifiInformationElementId). The next octet is a length field and
       
    39  * encodes the number of octets in the third and final field, which is
       
    40  * the IE Information field.
       
    41  *
       
    42  * The class ns3::WifiInformationElement provides a base for classes
       
    43  * which represent specific Information Elements. This class defines
       
    44  * pure virtual methods for serialisation
       
    45  * (ns3::WifiInformationElement::SerializeInformationField) and
       
    46  * deserialisation
       
    47  * (ns3::WifiInformationElement::DeserializeInformationField) of IEs, from
       
    48  * or to data members or other objects that simulation objects use to
       
    49  * maintain the relevant state.
       
    50  *
       
    51  * This class also provides an implementation of the equality
       
    52  * operator, which operates by comparing the serialised versions of
       
    53  * the two WifiInformationElement objects concerned.
       
    54  */
       
    55 
    26 
    56 namespace ns3 {
    27 namespace ns3 {
    57 
    28 
    58 /**
    29 /**
    59  * This type is used to represent an Information Element ID. An
    30  * This type is used to represent an Information Element ID. An
   119 // 222 to 255 are reserved in 802.11-2007
    90 // 222 to 255 are reserved in 802.11-2007
   120 
    91 
   121 
    92 
   122 /**
    93 /**
   123  * \brief Information element, as defined in 802.11-2007 standard
    94  * \brief Information element, as defined in 802.11-2007 standard
       
    95  * \ingroup wifi
       
    96  *
       
    97  * The IEEE 802.11 standard includes the notion of Information
       
    98  * Elements, which are encodings of management information to be
       
    99  * communicated between STAs in the payload of various frames of type
       
   100  * Management. Information Elements (IEs) have a common format, each
       
   101  * starting with a single octet - the Element ID, which indicates the
       
   102  * specific type of IE (a type to represent the options here is
       
   103  * defined as WifiInformationElementId). The next octet is a length field and
       
   104  * encodes the number of octets in the third and final field, which is
       
   105  * the IE Information field.
       
   106  *
       
   107  * The class ns3::WifiInformationElement provides a base for classes
       
   108  * which represent specific Information Elements. This class defines
       
   109  * pure virtual methods for serialisation
       
   110  * (ns3::WifiInformationElement::SerializeInformationField) and
       
   111  * deserialisation
       
   112  * (ns3::WifiInformationElement::DeserializeInformationField) of IEs, from
       
   113  * or to data members or other objects that simulation objects use to
       
   114  * maintain the relevant state.
       
   115  *
       
   116  * This class also provides an implementation of the equality
       
   117  * operator, which operates by comparing the serialised versions of
       
   118  * the two WifiInformationElement objects concerned.
   124  *
   119  *
   125  * Elements are defined to have a common general format consisting of
   120  * Elements are defined to have a common general format consisting of
   126  * a 1 octet Element ID field, a 1 octet length field, and a
   121  * a 1 octet Element ID field, a 1 octet length field, and a
   127  * variable-length element-specific information field. Each element is
   122  * variable-length element-specific information field. Each element is
   128  * assigned a unique Element ID as defined in this standard. The
   123  * assigned a unique Element ID as defined in this standard. The