Represent the Superframe Specification information field. More...
#include "lr-wpan-fields.h"
Public Member Functions | |
SuperframeField () | |
SuperframeField (uint16_t bitmap) | |
Create a superframe Specification Information field with the information specified in the bitmap. | |
uint8_t | GetBeaconOrder () const |
Get the Superframe Specification Beacon Order field. | |
uint8_t | GetFinalCapSlot () const |
Get the the Final CAP Slot. | |
uint8_t | GetFrameOrder () const |
Get the Superframe Specification Frame Order field. | |
uint16_t | GetSuperframe () const |
Get the Superframe specification information field. | |
bool | IsAssocPermit () const |
Check if the Association Permit bit is enabled. | |
bool | IsBattLifeExt () const |
Check if the Battery Life Extension bit is enabled. | |
bool | IsPanCoor () const |
Check if the PAN Coordinator bit is enabled. | |
void | SetAssocPermit (bool assocPermit) |
Set the Superframe Specification Association Permit field. | |
void | SetBattLifeExt (bool battLifeExt) |
Set the Superframe Specification Battery Life Extension (BLE). | |
void | SetBeaconOrder (uint8_t bcnOrder) |
Set the superframe specification Beacon Order field. | |
void | SetFinalCapSlot (uint8_t capSlot) |
Set the superframe specification Final CAP slot field. | |
void | SetPanCoor (bool panCoor) |
Set the Superframe Specification PAN coordinator field. | |
void | SetSuperframe (uint16_t superFrm) |
Set the whole Superframe Specification Information field. | |
void | SetSuperframeOrder (uint8_t frmOrder) |
Set the superframe specification Superframe Order field. | |
Private Attributes | |
bool | m_sspecAssocPermit |
Superframe Specification field Association Permit (Bit 15) | |
bool | m_sspecBatLifeExt |
Superframe Specification field Battery Life Extension (Bit 12) | |
uint8_t | m_sspecBcnOrder |
Superframe Specification field Beacon Order (Bit 0-3) | |
uint8_t | m_sspecFnlCapSlot |
Superframe Specification field Final CAP slot (Bit 8-11) | |
bool | m_sspecPanCoor |
Superframe Specification field PAN Coordinator (Bit 14) | |
uint8_t | m_sspecSprFrmOrder |
Superframe Specification field Superframe Order (Bit 4-7) | |
Represent the Superframe Specification information field.
See IEEE 802.15.4-2011 Section 5.2.2.1.2 Figure 41
Definition at line 44 of file lr-wpan-fields.h.
ns3::lrwpan::SuperframeField::SuperframeField | ( | ) |
Definition at line 19 of file lr-wpan-fields.cc.
References SetAssocPermit(), SetBattLifeExt(), SetBeaconOrder(), SetFinalCapSlot(), SetPanCoor(), and SetSuperframeOrder().
ns3::lrwpan::SuperframeField::SuperframeField | ( | uint16_t | bitmap | ) |
Create a superframe Specification Information field with the information specified in the bitmap.
bitmap | The superframe in bitmap form |
Definition at line 29 of file lr-wpan-fields.cc.
References SetSuperframe().
uint8_t ns3::lrwpan::SuperframeField::GetBeaconOrder | ( | ) | const |
Get the Superframe Specification Beacon Order field.
Definition at line 104 of file lr-wpan-fields.cc.
References m_sspecBcnOrder.
Referenced by ns3::lrwpan::operator<<(), and ns3::lrwpan::LrWpanMac::ReceiveBeacon().
uint8_t ns3::lrwpan::SuperframeField::GetFinalCapSlot | ( | ) | const |
Get the the Final CAP Slot.
Definition at line 116 of file lr-wpan-fields.cc.
References m_sspecFnlCapSlot.
Referenced by ns3::lrwpan::operator<<(), and ns3::lrwpan::LrWpanMac::ReceiveBeacon().
uint8_t ns3::lrwpan::SuperframeField::GetFrameOrder | ( | ) | const |
Get the Superframe Specification Frame Order field.
Definition at line 110 of file lr-wpan-fields.cc.
References m_sspecSprFrmOrder.
Referenced by ns3::lrwpan::operator<<(), and ns3::lrwpan::LrWpanMac::ReceiveBeacon().
uint16_t ns3::lrwpan::SuperframeField::GetSuperframe | ( | ) | const |
Get the Superframe specification information field.
Definition at line 140 of file lr-wpan-fields.cc.
References m_sspecAssocPermit, m_sspecBatLifeExt, m_sspecBcnOrder, m_sspecFnlCapSlot, m_sspecPanCoor, and m_sspecSprFrmOrder.
Referenced by ns3::lrwpan::LrWpanMac::GetSuperframeField().
bool ns3::lrwpan::SuperframeField::IsAssocPermit | ( | ) | const |
Check if the Association Permit bit is enabled.
Definition at line 134 of file lr-wpan-fields.cc.
References m_sspecAssocPermit.
Referenced by ns3::lrwpan::operator<<(), and ScanConfirm().
bool ns3::lrwpan::SuperframeField::IsBattLifeExt | ( | ) | const |
Check if the Battery Life Extension bit is enabled.
Definition at line 122 of file lr-wpan-fields.cc.
References m_sspecBatLifeExt.
Referenced by ns3::lrwpan::operator<<(), and ns3::lrwpan::LrWpanMac::ReceiveBeacon().
bool ns3::lrwpan::SuperframeField::IsPanCoor | ( | ) | const |
Check if the PAN Coordinator bit is enabled.
Definition at line 128 of file lr-wpan-fields.cc.
References m_sspecPanCoor.
Referenced by ns3::lrwpan::operator<<().
void ns3::lrwpan::SuperframeField::SetAssocPermit | ( | bool | assocPermit | ) |
Set the Superframe Specification Association Permit field.
assocPermit | set true or false the value of the Association Permit flag of the superframe field. |
Definition at line 98 of file lr-wpan-fields.cc.
References m_sspecAssocPermit.
Referenced by SuperframeField(), and ns3::lrwpan::LrWpanMac::GetSuperframeField().
void ns3::lrwpan::SuperframeField::SetBattLifeExt | ( | bool | battLifeExt | ) |
Set the Superframe Specification Battery Life Extension (BLE).
battLifeExt | Sets true or false the value of the Battery Life Extension flag of the superframe field. |
Definition at line 86 of file lr-wpan-fields.cc.
References m_sspecBatLifeExt.
Referenced by SuperframeField(), and ns3::lrwpan::LrWpanMac::GetSuperframeField().
void ns3::lrwpan::SuperframeField::SetBeaconOrder | ( | uint8_t | bcnOrder | ) |
Set the superframe specification Beacon Order field.
bcnOrder | The beacon order value to set in the superframe. |
Definition at line 47 of file lr-wpan-fields.cc.
References m_sspecBcnOrder, and NS_ABORT_MSG.
Referenced by SuperframeField(), and ns3::lrwpan::LrWpanMac::GetSuperframeField().
void ns3::lrwpan::SuperframeField::SetFinalCapSlot | ( | uint8_t | capSlot | ) |
Set the superframe specification Final CAP slot field.
capSlot | Set the final slot of the Contention Access Period (CAP). |
Definition at line 73 of file lr-wpan-fields.cc.
References m_sspecFnlCapSlot, and NS_ABORT_MSG.
Referenced by SuperframeField(), and ns3::lrwpan::LrWpanMac::GetSuperframeField().
void ns3::lrwpan::SuperframeField::SetPanCoor | ( | bool | panCoor | ) |
Set the Superframe Specification PAN coordinator field.
panCoor | set true or false the value for the PAN Coordinator flag of the superframe field. |
Definition at line 92 of file lr-wpan-fields.cc.
References m_sspecPanCoor.
Referenced by SuperframeField(), and ns3::lrwpan::LrWpanMac::GetSuperframeField().
void ns3::lrwpan::SuperframeField::SetSuperframe | ( | uint16_t | superFrm | ) |
Set the whole Superframe Specification Information field.
superFrm | The Superframe Specification information field. |
Definition at line 35 of file lr-wpan-fields.cc.
References m_sspecAssocPermit, m_sspecBatLifeExt, m_sspecBcnOrder, m_sspecFnlCapSlot, m_sspecPanCoor, and m_sspecSprFrmOrder.
Referenced by SuperframeField().
void ns3::lrwpan::SuperframeField::SetSuperframeOrder | ( | uint8_t | frmOrder | ) |
Set the superframe specification Superframe Order field.
frmOrder | The frame Order value to set on the superframe. |
Definition at line 60 of file lr-wpan-fields.cc.
References m_sspecSprFrmOrder, and NS_ABORT_MSG.
Referenced by SuperframeField(), and ns3::lrwpan::LrWpanMac::GetSuperframeField().
|
private |
Superframe Specification field Association Permit (Bit 15)
Definition at line 139 of file lr-wpan-fields.h.
Referenced by GetSuperframe(), IsAssocPermit(), SetAssocPermit(), and SetSuperframe().
|
private |
Superframe Specification field Battery Life Extension (Bit 12)
Superframe Specification field Reserved (not necessary) (Bit 13)
Definition at line 136 of file lr-wpan-fields.h.
Referenced by GetSuperframe(), IsBattLifeExt(), SetBattLifeExt(), and SetSuperframe().
|
private |
Superframe Specification field Beacon Order (Bit 0-3)
Definition at line 133 of file lr-wpan-fields.h.
Referenced by GetBeaconOrder(), GetSuperframe(), SetBeaconOrder(), and SetSuperframe().
|
private |
Superframe Specification field Final CAP slot (Bit 8-11)
Definition at line 135 of file lr-wpan-fields.h.
Referenced by GetFinalCapSlot(), GetSuperframe(), SetFinalCapSlot(), and SetSuperframe().
|
private |
Superframe Specification field PAN Coordinator (Bit 14)
Definition at line 138 of file lr-wpan-fields.h.
Referenced by GetSuperframe(), IsPanCoor(), SetPanCoor(), and SetSuperframe().
|
private |
Superframe Specification field Superframe Order (Bit 4-7)
Definition at line 134 of file lr-wpan-fields.h.
Referenced by GetFrameOrder(), GetSuperframe(), SetSuperframe(), and SetSuperframeOrder().