ns3::zigbee::SuperframeInformation Class Reference

Represent the Superframe Specification information field. More...

#include "zigbee-nwk-fields.h"

Collaboration diagram for ns3::zigbee::SuperframeInformation:

Public Member Functions
	SuperframeInformation ()
	SuperframeInformation (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	GetFrameOrder () const
	Get the Superframe Specification Frame Order field.
bool	IsAssocPermit () const
	Check if the Association Permit bit is enabled.
bool	IsPanCoor () const
	Check if the PAN Coordinator bit is enabled.
void	SetSuperframe (uint16_t superFrm)
	Set the whole Superframe Specification Information field.

Private Attributes
bool	m_sspecAssocPermit
	Superframe Specification field Association Permit (Bit 15)
uint8_t	m_sspecBcnOrder
	Superframe Specification field Beacon Order (Bit 0-3)
bool	m_sspecPanCoor
	Superframe Specification field PAN Coordinator (Bit 14)
uint8_t	m_sspecSprFrmOrder
	Superframe Specification field Superframe Order (Bit 4-7)

Detailed Description

Represent the Superframe Specification information field.

See IEEE 802.15.4-2011 Section 5.2.2.1.2 Figure 41

Definition at line 173 of file zigbee-nwk-fields.h.

Constructor & Destructor Documentation

SuperframeInformation() [1/2]

ns3::zigbee::SuperframeInformation::SuperframeInformation

(

)

Definition at line 118 of file zigbee-nwk-fields.cc.

SuperframeInformation() [2/2]

ns3::zigbee::SuperframeInformation::SuperframeInformation

(

uint16_t

bitmap

)

Create a superframe Specification Information field with the information specified in the bitmap.

Parameters

bitmap

The superframe in bitmap form

Definition at line 122 of file zigbee-nwk-fields.cc.

References SetSuperframe().

Here is the call graph for this function:

Member Function Documentation

GetBeaconOrder()

uint8_t ns3::zigbee::SuperframeInformation::GetBeaconOrder

(

)

const

Get the Superframe Specification Beacon Order field.

Returns

the Superframe Specification Beacon Order field.

Definition at line 138 of file zigbee-nwk-fields.cc.

References m_sspecBcnOrder.

Referenced by ns3::zigbee::ZigbeeNwk::MlmeBeaconNotifyIndication().

Here is the caller graph for this function:

GetFrameOrder()

uint8_t ns3::zigbee::SuperframeInformation::GetFrameOrder

(

)

const

Get the Superframe Specification Frame Order field.

Returns

The Superframe Specification Frame Order field.

Definition at line 144 of file zigbee-nwk-fields.cc.

References m_sspecSprFrmOrder.

Referenced by ns3::zigbee::ZigbeeNwk::MlmeBeaconNotifyIndication().

Here is the caller graph for this function:

IsAssocPermit()

bool ns3::zigbee::SuperframeInformation::IsAssocPermit

(

)

const

Check if the Association Permit bit is enabled.

Returns

true if the Association Permit bit is enabled

Definition at line 156 of file zigbee-nwk-fields.cc.

References m_sspecAssocPermit.

Referenced by ns3::zigbee::ZigbeeNwk::MlmeBeaconNotifyIndication().

Here is the caller graph for this function:

IsPanCoor()

bool ns3::zigbee::SuperframeInformation::IsPanCoor

(

)

const

Check if the PAN Coordinator bit is enabled.

Returns

true if the PAN Coordinator bit is enabled

Definition at line 150 of file zigbee-nwk-fields.cc.

References m_sspecPanCoor.

SetSuperframe()

void ns3::zigbee::SuperframeInformation::SetSuperframe

(

uint16_t

superFrm

)

Set the whole Superframe Specification Information field.

Parameters

superFrm

The Superframe Specification information field.

Definition at line 128 of file zigbee-nwk-fields.cc.

References m_sspecAssocPermit, m_sspecBcnOrder, m_sspecPanCoor, and m_sspecSprFrmOrder.

Referenced by SuperframeInformation().

Here is the caller graph for this function:

Member Data Documentation

m_sspecAssocPermit

bool ns3::zigbee::SuperframeInformation::m_sspecAssocPermit

private

Superframe Specification field Association Permit (Bit 15)

Definition at line 223 of file zigbee-nwk-fields.h.

Referenced by IsAssocPermit(), and SetSuperframe().

m_sspecBcnOrder

uint8_t ns3::zigbee::SuperframeInformation::m_sspecBcnOrder

private

Superframe Specification field Beacon Order (Bit 0-3)

Definition at line 219 of file zigbee-nwk-fields.h.

Referenced by GetBeaconOrder(), and SetSuperframe().

m_sspecPanCoor

bool ns3::zigbee::SuperframeInformation::m_sspecPanCoor

private

Superframe Specification field PAN Coordinator (Bit 14)

Definition at line 222 of file zigbee-nwk-fields.h.

Referenced by IsPanCoor(), and SetSuperframe().

m_sspecSprFrmOrder

uint8_t ns3::zigbee::SuperframeInformation::m_sspecSprFrmOrder

private

Superframe Specification field Superframe Order (Bit 4-7)

Definition at line 220 of file zigbee-nwk-fields.h.

Referenced by GetFrameOrder(), and SetSuperframe().

---

The documentation for this class was generated from the following files:

• src/zigbee/model/zigbee-nwk-fields.h
• src/zigbee/model/zigbee-nwk-fields.cc