A Discrete-Event Network Simulator
API
lr-wpan-mac-pl-headers.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 Ritsumeikan University, Shiga, Japan.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Alberto Gallegos Ramonet <ramonet@fc.ritsumei.ac.jp>
18  */
19 
20 #ifndef LR_WPAN_MAC_PL_HEADERS_H
21 #define LR_WPAN_MAC_PL_HEADERS_H
22 
23 #include "lr-wpan-fields.h"
24 
25 #include <ns3/header.h>
26 #include <ns3/mac16-address.h>
27 #include <ns3/mac64-address.h>
28 
29 namespace ns3
30 {
31 
38 {
39  public:
45  static TypeId GetTypeId();
46  TypeId GetInstanceTypeId() const override;
47  uint32_t GetSerializedSize() const override;
48  void Serialize(Buffer::Iterator start) const override;
49  uint32_t Deserialize(Buffer::Iterator start) override;
50  void Print(std::ostream& os) const override;
60  void SetGtsFields(GtsFields gtsFields);
65  void SetPndAddrFields(PendingAddrFields pndAddrFields);
75  GtsFields GetGtsFields() const;
81 
82  private:
95 };
96 
103 {
104  public:
110  {
114  DATA_REQ = 0x04,
115  PANID_CONFLICT = 0x05,
116  ORPHAN_NOTIF = 0x06,
117  BEACON_REQ = 0x07,
118  COOR_REALIGN = 0x08,
119  GTS_REQ = 0x09,
120  CMD_RESERVED = 0xff
121  };
122 
128  {
129  SUCCESSFUL = 0x00,
130  FULL_CAPACITY = 0x01,
131  ACCESS_DENIED = 0x02
132  };
133 
144  static TypeId GetTypeId();
145  TypeId GetInstanceTypeId() const override;
146  uint32_t GetSerializedSize() const override;
147  void Serialize(Buffer::Iterator start) const override;
148  uint32_t Deserialize(Buffer::Iterator start) override;
149  void Print(std::ostream& os) const override;
150 
155  void SetCommandFrameType(MacCommand macCmd);
166  void SetShortAddr(Mac16Address shortAddr);
171  void SetAssociationStatus(AssocStatus status);
176  Mac16Address GetShortAddr() const;
193 
194  private:
201 };
202 
203 } // namespace ns3
204 
205 #endif /* LR_WPAN_MAC_PL_HEADERS_H */
Implements the header for the MAC payload beacon frame according to the IEEE 802.15....
GtsFields GetGtsFields() const
Get the Guaranteed Time Slots (GTS) fields from the beacon payload header.
GtsFields m_gtsFields
GTS Fields.
PendingAddrFields m_pndAddrFields
Pending Address Fields.
PendingAddrFields GetPndAddrFields() const
Get the pending address fields from the beacon payload header.
SuperframeField m_superframeField
Superframe Specification Field.
void Print(std::ostream &os) const override
TypeId GetInstanceTypeId() const override
Get the most derived TypeId for this Object.
static TypeId GetTypeId()
Get the type ID.
void Serialize(Buffer::Iterator start) const override
void SetSuperframeSpecField(SuperframeField sfrmField)
Set the superframe specification field to the beacon payload header.
uint32_t GetSerializedSize() const override
void SetGtsFields(GtsFields gtsFields)
Set the superframe Guaranteed Time Slot (GTS) fields to the beacon payload header.
SuperframeField GetSuperframeSpecField() const
Get the superframe specification field from the beacon payload header.
void SetPndAddrFields(PendingAddrFields pndAddrFields)
Set the superframe Pending Address fields to the beacon payload header.
iterator in a Buffer instance
Definition: buffer.h:100
Represent the Capability Information Field.
Implements the header for the MAC payload command frame according to the IEEE 802....
AssocStatus
Association Status Field values.
@ SUCCESSFUL
Association successful.
CapabilityField GetCapabilityField() const
Get the Capability Information Field from the command payload header.
Mac16Address GetShortAddr() const
Get the Short address assigned by the coordinator (Association Response Command).
void SetCapabilityField(CapabilityField cap)
Set the Capability Information Field to the command payload header (Association Request Command).
AssocStatus GetAssociationStatus() const
Get the status resulting from an association request (Association Response Command).
CapabilityField m_capabilityInfo
Capability Information Field (Association Request Command)
MacCommand m_cmdFrameId
The command Frame Identifier.
void SetAssociationStatus(AssocStatus status)
Set status resulting from the association attempt (Association Response Command).
MacCommand GetCommandFrameType() const
Get the command frame type ID.
MacCommand
The MAC command frames.
@ ASSOCIATION_RESP
Association response (RFD true: Rx)
@ BEACON_REQ
Beacon Request (RFD true: none )
@ DATA_REQ
Data Request (RFD true: Tx)
@ ORPHAN_NOTIF
Orphan Notification (RFD true: Tx)
@ ASSOCIATION_REQ
Association request (RFD true: Tx)
@ DISASSOCIATION_NOTIF
Disassociation notification (RFD true: TX, Rx)
@ COOR_REALIGN
Coordinator Realignment (RFD true: Rx)
@ PANID_CONFLICT
Pan ID conflict notification (RFD true: Tx)
@ GTS_REQ
GTS Request (RFD true: none)
void Serialize(Buffer::Iterator start) const override
void SetCommandFrameType(MacCommand macCmd)
Set the command frame type.
static TypeId GetTypeId()
Get the type ID.
TypeId GetInstanceTypeId() const override
Get the most derived TypeId for this Object.
Mac16Address m_shortAddr
Contains the short address assigned by the coordinator (Association Response Command) See IEEE 802....
AssocStatus m_assocStatus
Association Status (Association Response Command)
void SetShortAddr(Mac16Address shortAddr)
Set the Short Address Assigned by the coordinator (Association Response Command).
uint32_t GetSerializedSize() const override
void Print(std::ostream &os) const override
Represent the GTS information fields.
Protocol header serialization and deserialization.
Definition: header.h:44
virtual uint32_t Deserialize(Buffer::Iterator start)=0
Deserialize the object from a buffer iterator.
This class can contain 16 bit addresses.
Definition: mac16-address.h:44
Represent the Pending Address Specification field.
Represent the Superframe Specification information field.
a unique identifier for an interface.
Definition: type-id.h:60
Every class exported by the ns3 library is enclosed in the ns3 namespace.