This section documents the API of the IEEE 802.15.4-related models. More...
Modules | |
LrWpan module tests | |
LrWpanConstants | |
Contains common parameters about LR-WPAN that can be reused in multiple files. | |
Classes | |
class | ns3::BeaconPayloadHeader |
Implements the header for the MAC payload beacon frame according to the IEEE 802.15.4-2011 Std. More... | |
class | ns3::CapabilityField |
Represent the Capability Information Field. More... | |
class | ns3::CommandPayloadHeader |
Implements the header for the MAC payload command frame according to the IEEE 802.15.4-2011 Std. More... | |
class | ns3::GtsFields |
Represent the GTS information fields. More... | |
class | ns3::LrWpanCsmaCa |
This class is a helper for the LrWpanMac to manage the Csma/CA state machine according to IEEE 802.15.4-2006, section 7.5.1.4. More... | |
struct | ns3::LrWpanEdPower |
Helper structure to manage the power measurement during ED. More... | |
class | ns3::LrWpanErrorModel |
Model the error rate for IEEE 802.15.4 2.4 GHz AWGN channel for OQPSK the model description can be found in IEEE Std 802.15.4-2006, section E.4.1.7. More... | |
class | ns3::LrWpanHelper |
helps to manage and create IEEE 802.15.4 NetDevice objects More... | |
class | ns3::LrWpanInterferenceHelper |
This class provides helper functions for LrWpan interference handling. More... | |
class | ns3::LrWpanLqiTag |
Represent the LQI (Link Quality Estination). More... | |
class | ns3::LrWpanMac |
Class that implements the LR-WPAN MAC state machine. More... | |
class | ns3::LrWpanMacHeader |
Represent the Mac Header with the Frame Control and Sequence Number fields. More... | |
struct | ns3::LrWpanMacPibAttributes |
IEEE802.15.4-2011 PHY PIB Attributes Table 52 in section 6.4.2. More... | |
class | ns3::LrWpanMacTrailer |
Represent the Mac Trailer with the Frame Check Sequence field. More... | |
class | ns3::LrWpanNetDevice |
Network layer to device interface. More... | |
class | ns3::LrWpanPhy |
Make LrWpanPhy a SpectrumPhy so we can enable the eventual modeling of device interference. More... | |
struct | ns3::LrWpanPhyDataAndSymbolRates |
This data structure provides the Bit rate and Symbol rate for a given channel See IEEE802.15.4-2006 Table 1 and 2 in section 6.1.1 and 6.1.2. More... | |
struct | ns3::LrWpanPhyPibAttributes |
IEEE802.15.4-2006 PHY PIB Attributes Table 23 in section 6.4.2. More... | |
struct | ns3::LrWpanPhyPpduHeaderSymbolNumber |
This data structure provides number of symbols for the PPDU headers: SHR and PHR See IEEE802.15.4-2006 Figure 16, Table 19 and 20 in section 6.3. More... | |
class | ns3::LrWpanSpectrumModelInitializer |
Helper class used to automatically initialize the LrWpan Spectrum Model objects. More... | |
struct | ns3::LrWpanSpectrumSignalParameters |
Signal parameters for LrWpan. More... | |
class | ns3::LrWpanSpectrumValueHelper |
This class defines all functions to create spectrum model for LrWpan. More... | |
struct | ns3::McpsDataConfirmParams |
MCPS-DATA.confirm params. More... | |
struct | ns3::McpsDataIndicationParams |
MCPS-DATA.indication params. More... | |
struct | ns3::McpsDataRequestParams |
MCPS-DATA.request params. More... | |
struct | ns3::MlmeAssociateConfirmParams |
MLME-ASSOCIATE.confirm params. More... | |
struct | ns3::MlmeAssociateIndicationParams |
MLME-ASSOCIATE.indication params. More... | |
struct | ns3::MlmeAssociateRequestParams |
MLME-ASSOCIATE.request params. More... | |
struct | ns3::MlmeAssociateResponseParams |
MLME-ASSOCIATE.response params. More... | |
struct | ns3::MlmeBeaconNotifyIndicationParams |
MLME-BEACON-NOTIFY.indication params. More... | |
struct | ns3::MlmeCommStatusIndicationParams |
MLME-COMM-STATUS.indication params. More... | |
struct | ns3::MlmeOrphanIndicationParams |
MLME-ORPHAN.indication params. More... | |
struct | ns3::MlmeOrphanResponseParams |
MLME-ORPHAN.response params. More... | |
struct | ns3::MlmePollConfirmParams |
MLME-START.confirm params. More... | |
struct | ns3::MlmePollRequestParams |
MLME-POLL.request params. More... | |
struct | ns3::MlmeScanConfirmParams |
MLME-SCAN.confirm params. More... | |
struct | ns3::MlmeScanRequestParams |
MLME-SCAN.request params. More... | |
struct | ns3::MlmeSetConfirmParams |
MLME-SET.confirm params. More... | |
struct | ns3::MlmeStartConfirmParams |
MLME-START.confirm params. More... | |
struct | ns3::MlmeStartRequestParams |
MLME-START.request params. More... | |
struct | ns3::MlmeSyncLossIndicationParams |
MLME-SYNC-LOSS.indication params. More... | |
struct | ns3::MlmeSyncRequestParams |
MLME-SYNC.request params. More... | |
struct | ns3::PanDescriptor |
PAN Descriptor, Table 17 IEEE 802.15.4-2011. More... | |
class | ns3::PendingAddrFields |
Represent the Pending Address Specification field. More... | |
class | ns3::SuperframeField |
Represent the Superframe Specification information field. More... | |
Typedefs | |
typedef void(* | ns3::TracedValueCallback::LrWpanMacState) (LrWpanMacState oldValue, LrWpanMacState newValue) |
TracedValue callback signature for LrWpanMacState. More... | |
typedef Callback< void, LrWpanMacState > | ns3::LrWpanMacStateCallback |
This method informs the MAC whether the channel is idle or busy. More... | |
typedef Callback< void, uint32_t > | ns3::LrWpanMacTransCostCallback |
This method informs the transaction cost in a slotted CSMA-CA data transmission. More... | |
typedef void(* | ns3::TracedValueCallback::LrWpanPhyEnumeration) (LrWpanPhyEnumeration oldValue, LrWpanPhyEnumeration newValue) |
TracedValue callback signature for LrWpanPhyEnumeration. More... | |
using | ns3::McpsDataConfirmCallback = Callback< void, McpsDataConfirmParams > |
This callback is called after a McpsDataRequest has been called from the higher layer. More... | |
using | ns3::McpsDataIndicationCallback = Callback< void, McpsDataIndicationParams, Ptr< Packet > > |
This callback is called after a Mcps has successfully received a frame and wants to deliver it to the higher layer. More... | |
using | ns3::MlmeAssociateConfirmCallback = Callback< void, MlmeAssociateConfirmParams > |
This callback is called after a MlmeAssociateRequest has been called from the higher layer. More... | |
using | ns3::MlmeAssociateIndicationCallback = Callback< void, MlmeAssociateIndicationParams > |
This callback is called after a Mlme has successfully received a command frame and wants to deliver it to the higher layer. More... | |
using | ns3::MlmeBeaconNotifyIndicationCallback = Callback< void, MlmeBeaconNotifyIndicationParams > |
This callback is called after a Mlme has successfully received a beacon frame and wants to deliver it to the higher layer. More... | |
using | ns3::MlmeCommStatusIndicationCallback = Callback< void, MlmeCommStatusIndicationParams > |
This callback is called by the MLME and issued to its next higher layer following a transmission instigated through a response primitive. More... | |
using | ns3::MlmeGetConfirmCallback = Callback< void, LrWpanMacStatus, LrWpanMacPibAttributeIdentifier, Ptr< LrWpanMacPibAttributes > > |
This callback is called after a MlmeGetRequest has been called from the higher layer to get a PIB. More... | |
using | ns3::MlmeOrphanIndicationCallback = Callback< void, MlmeOrphanIndicationParams > |
This callback is called by the MLME and issued to its next higher layer following the reception of a orphan notification. More... | |
using | ns3::MlmePollConfirmCallback = Callback< void, MlmePollConfirmParams > |
This callback is called after a Mlme-Poll.Request has been called from the higher layer. More... | |
using | ns3::MlmeScanConfirmCallback = Callback< void, MlmeScanConfirmParams > |
This callback is called after a MlmeScanRequest has been called from the higher layer. More... | |
using | ns3::MlmeSetConfirmCallback = Callback< void, MlmeSetConfirmParams > |
This callback is called after a MlmeSetRequest has been called from the higher layer to set a PIB. More... | |
using | ns3::MlmeStartConfirmCallback = Callback< void, MlmeStartConfirmParams > |
This callback is called after a MlmeStartRequest has been called from the higher layer. More... | |
using | ns3::MlmeSyncLossIndicationCallback = Callback< void, MlmeSyncLossIndicationParams > |
This callback is called to indicate the loss of synchronization with a coordinator. More... | |
typedef Callback< void, LrWpanPhyEnumeration > | ns3::PdDataConfirmCallback |
This method implements the PD SAP: PdDataConfirm. More... | |
typedef Callback< void, uint32_t, Ptr< Packet >, uint8_t > | ns3::PdDataIndicationCallback |
This method implements the PD SAP: PdDataIndication. More... | |
typedef Callback< void, LrWpanPhyEnumeration > | ns3::PlmeCcaConfirmCallback |
This method implements the PD SAP: PlmeCcaConfirm. More... | |
typedef Callback< void, LrWpanPhyEnumeration, uint8_t > | ns3::PlmeEdConfirmCallback |
This method implements the PD SAP: PlmeEdConfirm. More... | |
typedef Callback< void, LrWpanPhyEnumeration, LrWpanPibAttributeIdentifier, Ptr< LrWpanPhyPibAttributes > > | ns3::PlmeGetAttributeConfirmCallback |
This method implements the PD SAP: PlmeGetAttributeConfirm. More... | |
typedef Callback< void, LrWpanPhyEnumeration, LrWpanPibAttributeIdentifier > | ns3::PlmeSetAttributeConfirmCallback |
This method implements the PD SAP: PlmeSetAttributeConfirm. More... | |
typedef Callback< void, LrWpanPhyEnumeration > | ns3::PlmeSetTRXStateConfirmCallback |
This method implements the PD SAP: PlmeSetTRXStateConfirm. More... | |
typedef void(* | ns3::TracedValueCallback::SuperframeStatus) (SuperframeStatus oldValue, SuperframeStatus newValue) |
TracedValue callback signature for SuperframeStatus. More... | |
Variables | |
class ns3::LrWpanSpectrumModelInitializer | ns3::g_LrWpanSpectrumModelInitializerInstance |
Global object used to initialize the LrWpan Spectrum Model. More... | |
This section documents the API of the IEEE 802.15.4-related models.
For a generic functional description, please refer to the ns-3 manual.
typedef void(* ns3::TracedValueCallback::LrWpanMacState) (LrWpanMacState oldValue, LrWpanMacState newValue) |
TracedValue callback signature for LrWpanMacState.
[in] | oldValue | original value of the traced variable |
[in] | newValue | new value of the traced variable |
Definition at line 142 of file lr-wpan-mac.h.
typedef Callback<void, LrWpanMacState> ns3::LrWpanMacStateCallback |
This method informs the MAC whether the channel is idle or busy.
Definition at line 41 of file lr-wpan-csmaca.h.
typedef Callback<void, uint32_t> ns3::LrWpanMacTransCostCallback |
This method informs the transaction cost in a slotted CSMA-CA data transmission.
i.e. Reports number of symbols (time) it would take slotted CSMA-CA to process the current transaction. 1 Transaction = 2 CCA + frame transmission (PPDU) + turnaroudtime or Ack time (optional) + IFS See IEEE 802.15.4-2011 (Sections 5.1.1.1 and 5.1.1.4)
Definition at line 50 of file lr-wpan-csmaca.h.
typedef void(* ns3::TracedValueCallback::LrWpanPhyEnumeration) (LrWpanPhyEnumeration oldValue, LrWpanPhyEnumeration newValue) |
TracedValue callback signature for LrWpanPhyEnumeration.
[in] | oldValue | original value of the traced variable |
[in] | newValue | new value of the traced variable |
Definition at line 154 of file lr-wpan-phy.h.
using ns3::McpsDataConfirmCallback = typedef Callback<void, McpsDataConfirmParams> |
This callback is called after a McpsDataRequest has been called from the higher layer.
It returns a status of the outcome of the transmission request
Definition at line 494 of file lr-wpan-mac-base.h.
using ns3::McpsDataIndicationCallback = typedef Callback<void, McpsDataIndicationParams, Ptr<Packet> > |
This callback is called after a Mcps has successfully received a frame and wants to deliver it to the higher layer.
Definition at line 505 of file lr-wpan-mac-base.h.
using ns3::MlmeAssociateConfirmCallback = typedef Callback<void, MlmeAssociateConfirmParams> |
This callback is called after a MlmeAssociateRequest has been called from the higher layer.
It returns a status of the outcome of the association request
Definition at line 564 of file lr-wpan-mac-base.h.
using ns3::MlmeAssociateIndicationCallback = typedef Callback<void, MlmeAssociateIndicationParams> |
This callback is called after a Mlme has successfully received a command frame and wants to deliver it to the higher layer.
Security related parameters and not handle. See 802.15.4-2011 6.2.2.2.
Definition at line 516 of file lr-wpan-mac-base.h.
using ns3::MlmeBeaconNotifyIndicationCallback = typedef Callback<void, MlmeBeaconNotifyIndicationParams> |
This callback is called after a Mlme has successfully received a beacon frame and wants to deliver it to the higher layer.
Definition at line 575 of file lr-wpan-mac-base.h.
using ns3::MlmeCommStatusIndicationCallback = typedef Callback<void, MlmeCommStatusIndicationParams> |
This callback is called by the MLME and issued to its next higher layer following a transmission instigated through a response primitive.
Security related parameters and not handle. See 802.15.4-2011 6.2.4.2
Definition at line 527 of file lr-wpan-mac-base.h.
using ns3::MlmeGetConfirmCallback = typedef Callback<void, LrWpanMacStatus, LrWpanMacPibAttributeIdentifier, Ptr<LrWpanMacPibAttributes> > |
This callback is called after a MlmeGetRequest has been called from the higher layer to get a PIB.
It returns a status of the outcome of the write attempt.
Definition at line 604 of file lr-wpan-mac-base.h.
using ns3::MlmeOrphanIndicationCallback = typedef Callback<void, MlmeOrphanIndicationParams> |
This callback is called by the MLME and issued to its next higher layer following the reception of a orphan notification.
Security related parameters and not handle. See 802.15.4-2011 6.2.7.1
Definition at line 538 of file lr-wpan-mac-base.h.
using ns3::MlmePollConfirmCallback = typedef Callback<void, MlmePollConfirmParams> |
This callback is called after a Mlme-Poll.Request has been called from the higher layer.
It returns a status of the outcome of the transmission request
Definition at line 614 of file lr-wpan-mac-base.h.
using ns3::MlmeScanConfirmCallback = typedef Callback<void, MlmeScanConfirmParams> |
This callback is called after a MlmeScanRequest has been called from the higher layer.
It returns a status of the outcome of the scan.
Definition at line 555 of file lr-wpan-mac-base.h.
using ns3::MlmeSetConfirmCallback = typedef Callback<void, MlmeSetConfirmParams> |
This callback is called after a MlmeSetRequest has been called from the higher layer to set a PIB.
It returns a status of the outcome of the write attempt.
Definition at line 595 of file lr-wpan-mac-base.h.
using ns3::MlmeStartConfirmCallback = typedef Callback<void, MlmeStartConfirmParams> |
This callback is called after a MlmeStartRequest has been called from the higher layer.
It returns a status of the outcome of the transmission request
Definition at line 547 of file lr-wpan-mac-base.h.
using ns3::MlmeSyncLossIndicationCallback = typedef Callback<void, MlmeSyncLossIndicationParams> |
This callback is called to indicate the loss of synchronization with a coordinator.
Definition at line 586 of file lr-wpan-mac-base.h.
typedef Callback<void, LrWpanPhyEnumeration> ns3::PdDataConfirmCallback |
This method implements the PD SAP: PdDataConfirm.
status | the status to be transmitted |
Definition at line 211 of file lr-wpan-phy.h.
typedef Callback<void, uint32_t, Ptr<Packet>, uint8_t> ns3::PdDataIndicationCallback |
This method implements the PD SAP: PdDataIndication.
psduLength | number of bytes in the PSDU |
p | the packet to be transmitted |
lqi | Link quality (LQI) value measured during reception of the PPDU |
Definition at line 202 of file lr-wpan-phy.h.
typedef Callback<void, LrWpanPhyEnumeration> ns3::PlmeCcaConfirmCallback |
This method implements the PD SAP: PlmeCcaConfirm.
status | the status of CCA |
Definition at line 220 of file lr-wpan-phy.h.
typedef Callback<void, LrWpanPhyEnumeration, uint8_t> ns3::PlmeEdConfirmCallback |
This method implements the PD SAP: PlmeEdConfirm.
status | the status of ED |
energyLevel | the energy level of ED |
Definition at line 230 of file lr-wpan-phy.h.
typedef Callback<void, LrWpanPhyEnumeration, LrWpanPibAttributeIdentifier, Ptr<LrWpanPhyPibAttributes> > ns3::PlmeGetAttributeConfirmCallback |
This method implements the PD SAP: PlmeGetAttributeConfirm.
status | the status of PlmeGetAttributeRequest |
id | the identifier of attribute |
attribute | the pointer to attribute struct |
Definition at line 245 of file lr-wpan-phy.h.
typedef Callback<void, LrWpanPhyEnumeration, LrWpanPibAttributeIdentifier> ns3::PlmeSetAttributeConfirmCallback |
This method implements the PD SAP: PlmeSetAttributeConfirm.
status | the status of PlmeSetAttributeRequest |
id | the identifier of attribute |
Definition at line 265 of file lr-wpan-phy.h.
typedef Callback<void, LrWpanPhyEnumeration> ns3::PlmeSetTRXStateConfirmCallback |
This method implements the PD SAP: PlmeSetTRXStateConfirm.
status | the status of PlmeSetTRXStateRequest |
Definition at line 254 of file lr-wpan-phy.h.
typedef void(* ns3::TracedValueCallback::SuperframeStatus) (SuperframeStatus oldValue, SuperframeStatus newValue) |
TracedValue callback signature for SuperframeStatus.
[in] | oldValue | original value of the traced variable |
[in] | newValue | new value of the traced variable |
Definition at line 151 of file lr-wpan-mac.h.
enum ns3::DeviceType |
The device Capabilities.
Enumerator | |
---|---|
RFD | Reduced Functional Device (RFD) |
FFD | Full Functional Device (FFD) |
Definition at line 42 of file lr-wpan-fields.h.
table 80 of 802.15.4
Enumerator | |
---|---|
NO_PANID_ADDR | |
ADDR_MODE_RESERVED | |
SHORT_ADDR | |
EXT_ADDR |
Definition at line 95 of file lr-wpan-mac-base.h.
IEEE802.15.4-2011 MAC PIB Attribute Identifiers Table 52 in section 6.4.2.
Enumerator | |
---|---|
macBeaconPayload | |
macBeaconPayloadLength | |
macShortAddress | |
macExtendedAddress | |
macPanId | |
pCurrentChannel | |
pCurrentPage | |
unsupported |
Definition at line 254 of file lr-wpan-mac-base.h.
enum ns3::LrWpanMacState |
MAC states.
Definition at line 71 of file lr-wpan-mac.h.
|
strong |
The status of a confirm or an indication primitive as a result of a previous request.
Represent the value of status in IEEE 802.15.4-2011 primitives. (Tables 6, 12, 18, 20, 31, 33, 35, 37, 39, 47)
Status codes values only appear in IEEE 802.15.4-2006, Table 78 See also NXP JN5169 IEEE 802.15.4 Stack User Guide (Table 6: Status Enumerations and Section 6.1.23)
Definition at line 48 of file lr-wpan-mac-base.h.
Table 30 of IEEE 802.15.4-2011.
Enumerator | |
---|---|
MLMESCAN_ED | |
MLMESCAN_ACTIVE | |
MLMESCAN_PASSIVE | |
MLMESCAN_ORPHAN |
Definition at line 108 of file lr-wpan-mac-base.h.
IEEE802.15.4-2006 PHY Emumerations Table 18 in section 6.2.3.
Definition at line 110 of file lr-wpan-phy.h.
enum ns3::LrWpanPhyOption |
This Phy option will be used to index various Tables in IEEE802.15.4-2011.
Definition at line 90 of file lr-wpan-phy.h.
IEEE802.15.4-2006 PHY PIB Attribute Identifiers Table 23 in section 6.4.2.
Enumerator | |
---|---|
phyCurrentChannel | |
phyChannelsSupported | |
phyTransmitPower | |
phyCCAMode | |
phyCurrentPage | |
phyMaxFrameDuration | |
phySHRDuration | |
phySymbolsPerOctet |
Definition at line 162 of file lr-wpan-phy.h.
enum ns3::LrWpanTxOption |
Tx options.
Enumerator | |
---|---|
TX_OPTION_NONE | TX_OPTION_NONE. |
TX_OPTION_ACK | TX_OPTION_ACK. |
TX_OPTION_GTS | TX_OPTION_GTS. |
TX_OPTION_INDIRECT | TX_OPTION_INDIRECT. |
Definition at line 58 of file lr-wpan-mac.h.
Indicates a pending MAC primitive.
Definition at line 123 of file lr-wpan-mac.h.
Superframe status.
Enumerator | |
---|---|
BEACON | The Beacon transmission or reception Period. |
CAP | Contention Access Period. |
CFP | Contention Free Period. |
INACTIVE | Inactive Period or unslotted CSMA-CA. |
Definition at line 99 of file lr-wpan-mac.h.
enum ns3::SuperframeType |
Superframe type.
Enumerator | |
---|---|
OUTGOING | Outgoing Superframe. |
INCOMING | Incoming Superframe. |
Definition at line 112 of file lr-wpan-mac.h.
class ns3::LrWpanSpectrumModelInitializer ns3::g_LrWpanSpectrumModelInitializerInstance |
Global object used to initialize the LrWpan Spectrum Model.