lr-wpan-fields.h

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2019 Ritsumeikan University, Shiga, Japan.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Alberto Gallegos Ramonet <ramonet@fc.ritsumei.ac.jp>
 *
 * This file implements Information Fields present in IEEE 802.15.4-2011.
 * Information Fields are in practice similar to the Information Elements(IE)
 * introduced in later revisions of the standard, however, they lack
 * descriptors and common format unlike the IEs. To keep this implementation
 * consistent with the IEEE 802.15.4-2011 std. the present file implements
 * Information Fields not Information Elements.
 */
#ifndef LR_WPAN_FIELDS_H
#define LR_WPAN_FIELDS_H


#include <ns3/mac16-address.h>
#include <ns3/mac64-address.h>
#include "ns3/buffer.h"
#include <array>


namespace ns3 {

enum DeviceType
{
  RFD = 0,                  
  FFD = 1                   
};

class SuperframeField
{

public:
  SuperframeField ();
  void SetSuperframe (uint16_t superFrm);
  void SetBeaconOrder (uint8_t bcnOrder);
  void SetSuperframeOrder (uint8_t frmOrder);
  void SetFinalCapSlot (uint8_t capSlot);
  void SetBattLifeExt (bool battLifeExt);
  void SetPanCoor (bool panCoor);
  void SetAssocPermit (bool assocPermit);
  uint8_t GetBeaconOrder (void) const;
  uint8_t GetFrameOrder (void) const;
  uint8_t GetFinalCapSlot (void) const;
  bool IsBattLifeExt (void) const;
  bool IsPanCoor (void) const;
  bool IsAssocPermit (void) const;
  uint16_t GetSuperframe (void) const;
  uint32_t GetSerializedSize (void) const;
  Buffer::Iterator Serialize (Buffer::Iterator i) const;
  Buffer::Iterator Deserialize (Buffer::Iterator i);


private:
  // Superframe Specification field
  // See IEEE 802.14.15-2011 5.2.2.1.2
  uint8_t m_sspecBcnOrder;    
  uint8_t m_sspecSprFrmOrder; 
  uint8_t m_sspecFnlCapSlot;  
  bool    m_sspecBatLifeExt;  
  bool    m_sspecPanCoor;     
  bool    m_sspecAssocPermit; 

};
std::ostream &operator << (std::ostream &os, const SuperframeField &superframeField);

class GtsFields
{

public:
  GtsFields ();
  uint8_t GetGtsSpecField (void) const;
  uint8_t GetGtsDirectionField (void) const;
  void SetGtsSpecField (uint8_t gtsSpec);
  void SetGtsDirectionField (uint8_t gtsDir);
  uint32_t GetSerializedSize (void) const;
  Buffer::Iterator Serialize (Buffer::Iterator i) const;
  Buffer::Iterator Deserialize (Buffer::Iterator i);

private:
  //GTS Descriptor
  struct gtsDescriptor
  {
    Mac16Address m_gtsDescDevShortAddr;      
    uint8_t m_gtsDescStartSlot;              
    uint8_t m_gtsDescLength;                 
  };

  //GTS specification field
  uint8_t m_gtsSpecDescCount;            
  uint8_t m_gtsSpecPermit;               
  //GTS Direction field
  uint8_t m_gtsDirMask;                  
  //GTS List
  gtsDescriptor m_gtsList[6];            
};
std::ostream &operator << (std::ostream &os, const GtsFields &gtsFields);



class PendingAddrFields
{

public:
  PendingAddrFields ();
  void AddAddress (Mac16Address shortAddr);
  void AddAddress (Mac64Address extAddr);
  bool SearchAddress (Mac16Address shortAddr);
  bool SearchAddress (Mac64Address extAddr);
  uint8_t GetPndAddrSpecField (void) const;
  uint8_t GetNumShortAddr (void) const;
  uint8_t GetNumExtAddr (void) const;

  void SetPndAddrSpecField (uint8_t pndAddrSpecField);
  uint32_t GetSerializedSize (void) const;
  Buffer::Iterator Serialize (Buffer::Iterator i) const;
  Buffer::Iterator Deserialize (Buffer::Iterator i);

private:
  // Pending Address Specification Field
  uint8_t m_pndAddrSpecNumShortAddr;           
  uint8_t m_pndAddrSpecNumExtAddr;             
  // Address List
  std::array <Mac16Address,7> m_shortAddrList;    
  std::array<Mac64Address,7>  m_extAddrList;      

};
std::ostream &operator << (std::ostream &os, const PendingAddrFields &pendingAddrFields);


}  //end namespace ns3

#endif /* LR_WPAN_FIELDS_H */