Implements the header for the MAC payload command frame according to the IEEE 802.15.4-2011 Std. More...

#include "lr-wpan-mac-pl-headers.h"

Inheritance diagram for ns3::CommandPayloadHeader:

Collaboration diagram for ns3::CommandPayloadHeader:

Public Types
enum	AssocStatus { SUCCESSFUL = 0x00 , FULL_CAPACITY = 0x01 , ACCESS_DENIED = 0x02 }
	Association Status Field values. More...

enum	MacCommand { ASSOCIATION_REQ = 0x01 , ASSOCIATION_RESP = 0x02 , DISASSOCIATION_NOTIF = 0x03 , DATA_REQ = 0x04 , PANID_CONFLICT = 0x05 , ORPHAN_NOTIF = 0x06 , BEACON_REQ = 0x07 , COOR_REALIGN = 0x08 , GTS_REQ = 0x09 , CMD_RESERVED = 0xff }
	The MAC command frames. More...

Public Member Functions
	CommandPayloadHeader ()

	CommandPayloadHeader (MacCommand macCmd)
	Constructor. More...

uint32_t	Deserialize (Buffer::Iterator start) override

AssocStatus	GetAssociationStatus () const
	Get the status resulting from an association request (Association Response Command). More...

CapabilityField	GetCapabilityField () const
	Get the Capability Information Field from the command payload header. More...

MacCommand	GetCommandFrameType () const
	Get the command frame type ID. More...

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

uint32_t	GetSerializedSize () const override

Mac16Address	GetShortAddr () const
	Get the Short address assigned by the coordinator (Association Response Command). More...

void	Print (std::ostream &os) const override

void	Serialize (Buffer::Iterator start) const override

void	SetAssociationStatus (AssocStatus status)
	Set status resulting from the association attempt (Association Response Command). More...

void	SetCapabilityField (CapabilityField cap)
	Set the Capability Information Field to the command payload header (Association Request Command). More...

void	SetCommandFrameType (MacCommand macCmd)
	Set the command frame type. More...

void	SetShortAddr (Mac16Address shortAddr)
	Set the Short Address Assigned by the coordinator (Association Response Command). More...

Public Member Functions inherited from ns3::Header
	~Header () override

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator. More...

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::Chunk
virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID. More...

Private Attributes
AssocStatus	m_assocStatus
	Association Status (Association Response Command) More...

CapabilityField	m_capabilityInfo
	Capability Information Field (Association Request Command) More...

MacCommand	m_cmdFrameId
	The command Frame Identifier. More...

Mac16Address	m_shortAddr
	Contains the short address assigned by the coordinator (Association Response Command) See IEEE 802.15.4-2011 5.3.2.2. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Implements the header for the MAC payload command frame according to the IEEE 802.15.4-2011 Std.

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 24 bytes (on a 64-bit architecture).

Definition at line 102 of file lr-wpan-mac-pl-headers.h.

Member Enumeration Documentation

◆ AssocStatus

enum ns3::CommandPayloadHeader::AssocStatus

Association Status Field values.

See IEEE 802.15.4-2011, Table 6

Enumerator
SUCCESSFUL	Association successful.
FULL_CAPACITY	PAN at capacity.
ACCESS_DENIED	PAN access denied.

Definition at line 127 of file lr-wpan-mac-pl-headers.h.

◆ MacCommand

enum ns3::CommandPayloadHeader::MacCommand

The MAC command frames.

See IEEE 802.15.4-2011, Table 5

Enumerator
ASSOCIATION_REQ	Association request (RFD true: Tx)
ASSOCIATION_RESP	Association response (RFD true: Rx)
DISASSOCIATION_NOTIF	Disassociation notification (RFD true: TX, Rx)
DATA_REQ	Data Request (RFD true: Tx)
PANID_CONFLICT	Pan ID conflict notification (RFD true: Tx)
ORPHAN_NOTIF	Orphan Notification (RFD true: Tx)
BEACON_REQ	Beacon Request (RFD true: none )
COOR_REALIGN	Coordinator Realignment (RFD true: Rx)
GTS_REQ	GTS Request (RFD true: none)
CMD_RESERVED	Reserved.

Definition at line 109 of file lr-wpan-mac-pl-headers.h.

Constructor & Destructor Documentation

◆ CommandPayloadHeader() [1/2]

ns3::CommandPayloadHeader::CommandPayloadHeader ( )

Definition at line 133 of file lr-wpan-mac-pl-headers.cc.

References CMD_RESERVED, and SetCommandFrameType().

Here is the call graph for this function:

◆ CommandPayloadHeader() [2/2]

ns3::CommandPayloadHeader::CommandPayloadHeader ( MacCommand macCmd )

Constructor.

Parameters

macCmd the command type of this command header

Definition at line 138 of file lr-wpan-mac-pl-headers.cc.

References SetCommandFrameType().

Here is the call graph for this function:

Member Function Documentation

◆ Deserialize()

uint32_t ns3::CommandPayloadHeader::Deserialize ( Buffer::Iterator start )

overridevirtual

Parameters

start an iterator which points to where the header should read from.

Returns: the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 229 of file lr-wpan-mac-pl-headers.cc.

References ASSOCIATION_REQ, ASSOCIATION_RESP, BEACON_REQ, CMD_RESERVED, COOR_REALIGN, DATA_REQ, ns3::CapabilityField::Deserialize(), DISASSOCIATION_NOTIF, ns3::Buffer::Iterator::GetDistanceFrom(), GTS_REQ, m_assocStatus, m_capabilityInfo, m_cmdFrameId, m_shortAddr, ORPHAN_NOTIF, PANID_CONFLICT, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadU8(), and two-ray-to-three-gpp-ch-calibration::start.

Here is the call graph for this function:

◆ GetAssociationStatus()

CommandPayloadHeader::AssocStatus ns3::CommandPayloadHeader::GetAssociationStatus ( ) const

Get the status resulting from an association request (Association Response Command).

Returns: The resulting status from an association request

Definition at line 372 of file lr-wpan-mac-pl-headers.cc.

References ASSOCIATION_RESP, m_assocStatus, m_cmdFrameId, and NS_ASSERT.

Referenced by ns3::LrWpanMac::PdDataConfirm().

Here is the caller graph for this function:

◆ GetCapabilityField()

CapabilityField ns3::CommandPayloadHeader::GetCapabilityField ( ) const

Get the Capability Information Field from the command payload header.

(Association Request Command)

Returns: The Capability Information Field

Definition at line 379 of file lr-wpan-mac-pl-headers.cc.

References ASSOCIATION_REQ, m_capabilityInfo, m_cmdFrameId, and NS_ASSERT.

Referenced by ns3::LrWpanMac::PdDataConfirm().

Here is the caller graph for this function:

◆ GetCommandFrameType()

CommandPayloadHeader::MacCommand ns3::CommandPayloadHeader::GetCommandFrameType ( ) const

Get the command frame type ID.

Returns: The command type ID from the command payload header

Definition at line 314 of file lr-wpan-mac-pl-headers.cc.

References ASSOCIATION_REQ, ASSOCIATION_RESP, BEACON_REQ, CMD_RESERVED, COOR_REALIGN, DATA_REQ, DISASSOCIATION_NOTIF, GTS_REQ, m_cmdFrameId, ORPHAN_NOTIF, and PANID_CONFLICT.

Referenced by ns3::LrWpanMac::PdDataConfirm(), ns3::LrWpanMac::PdDataIndication(), ns3::LrWpanMac::PrepareRetransmission(), ns3::LrWpanMac::SendAssocResponseCommand(), and ns3::LrWpanMac::SetLrWpanMacState().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::CommandPayloadHeader::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 156 of file lr-wpan-mac-pl-headers.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::CommandPayloadHeader::GetSerializedSize ( ) const

overridevirtual

Returns: the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 162 of file lr-wpan-mac-pl-headers.cc.

References ASSOCIATION_REQ, ASSOCIATION_RESP, BEACON_REQ, CMD_RESERVED, COOR_REALIGN, DATA_REQ, DISASSOCIATION_NOTIF, ns3::CapabilityField::GetSerializedSize(), GTS_REQ, m_capabilityInfo, m_cmdFrameId, ORPHAN_NOTIF, and PANID_CONFLICT.

Here is the call graph for this function:

◆ GetShortAddr()

Mac16Address ns3::CommandPayloadHeader::GetShortAddr ( ) const

Get the Short address assigned by the coordinator (Association Response Command).

Returns: The Mac16Address assigned by the coordinator

Definition at line 365 of file lr-wpan-mac-pl-headers.cc.

References ASSOCIATION_RESP, m_cmdFrameId, m_shortAddr, and NS_ASSERT.

Referenced by ns3::LrWpanMac::PdDataConfirm().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::CommandPayloadHeader::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 146 of file lr-wpan-mac-pl-headers.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Print()

void ns3::CommandPayloadHeader::Print ( std::ostream & os ) const

overridevirtual

Parameters

os output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 265 of file lr-wpan-mac-pl-headers.cc.

References ASSOCIATION_REQ, ASSOCIATION_RESP, BEACON_REQ, CMD_RESERVED, COOR_REALIGN, DATA_REQ, DISASSOCIATION_NOTIF, GTS_REQ, ns3::CapabilityField::IsDeviceTypeFfd(), ns3::CapabilityField::IsPowSrcAvailable(), ns3::CapabilityField::IsReceiverOnWhenIdle(), ns3::CapabilityField::IsSecurityCapability(), ns3::CapabilityField::IsShortAddrAllocOn(), m_assocStatus, m_capabilityInfo, m_cmdFrameId, m_shortAddr, ORPHAN_NOTIF, and PANID_CONFLICT.

Here is the call graph for this function:

◆ Serialize()

void ns3::CommandPayloadHeader::Serialize ( Buffer::Iterator start ) const

overridevirtual

Parameters

start an iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 195 of file lr-wpan-mac-pl-headers.cc.

References ASSOCIATION_REQ, ASSOCIATION_RESP, BEACON_REQ, CMD_RESERVED, COOR_REALIGN, DATA_REQ, DISASSOCIATION_NOTIF, GTS_REQ, m_assocStatus, m_capabilityInfo, m_cmdFrameId, m_shortAddr, ORPHAN_NOTIF, PANID_CONFLICT, ns3::CapabilityField::Serialize(), two-ray-to-three-gpp-ch-calibration::start, ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().