A Discrete-Event Network Simulator
API
ns3::BeaconPayloadHeader Class Reference

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

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

+ Inheritance diagram for ns3::BeaconPayloadHeader:
+ Collaboration diagram for ns3::BeaconPayloadHeader:

Public Member Functions

 BeaconPayloadHeader ()
 
uint32_t Deserialize (Buffer::Iterator start)
 
GtsFields GetGtsFields (void) const
 Get the Guaranteed Time Slots (GTS) fields from the beacon payload header. More...
 
TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
PendingAddrFields GetPndAddrFields (void) const
 Get the pending address fields from the beacon payload header. More...
 
uint32_t GetSerializedSize (void) const
 
SuperframeField GetSuperframeSpecField (void) const
 Get the superframe specification field from the beacon payload header. More...
 
void Print (std::ostream &os) const
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetGtsFields (GtsFields gtsFields)
 Set the superframe Guaranteed Time Slot (GTS) fields to the beacon payload header. More...
 
void SetPndAddrFields (PendingAddrFields pndAddrFields)
 Set the superframe Pending Address fields to the beacon payload header. More...
 
void SetSuperframeSpecField (SuperframeField sfrmField)
 Set the superframe specification field to the beacon payload header. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
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 erros. 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 (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

GtsFields m_gtsFields
 GTS Fields. More...
 
PendingAddrFields m_pndAddrFields
 Pending Address Fields. More...
 
SuperframeField m_superframeField
 Superframe Specification Field. 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Implements the header for the MAC payload beacon 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 120 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ BeaconPayloadHeader()

ns3::BeaconPayloadHeader::BeaconPayloadHeader ( )

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

Member Function Documentation

◆ Deserialize()

uint32_t ns3::BeaconPayloadHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan 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 74 of file lr-wpan-mac-pl-headers.cc.

References ns3::SuperframeField::Deserialize(), ns3::GtsFields::Deserialize(), ns3::PendingAddrFields::Deserialize(), ns3::Buffer::Iterator::GetDistanceFrom(), m_gtsFields, m_pndAddrFields, m_superframeField, and visualizer.core::start().

+ Here is the call graph for this function:

◆ GetGtsFields()

GtsFields ns3::BeaconPayloadHeader::GetGtsFields ( void  ) const

Get the Guaranteed Time Slots (GTS) fields from the beacon payload header.

Returns
The GTS fields.

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

References m_gtsFields.

◆ GetInstanceTypeId()

TypeId ns3::BeaconPayloadHeader::GetInstanceTypeId ( void  ) const
virtual

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 48 of file lr-wpan-mac-pl-headers.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetPndAddrFields()

PendingAddrFields ns3::BeaconPayloadHeader::GetPndAddrFields ( void  ) const

Get the pending address fields from the beacon payload header.

Returns
The Pending Address fields.

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

References m_pndAddrFields.

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

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::BeaconPayloadHeader::GetSerializedSize ( void  ) const
virtual
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 54 of file lr-wpan-mac-pl-headers.cc.

References ns3::SuperframeField::GetSerializedSize(), ns3::GtsFields::GetSerializedSize(), ns3::PendingAddrFields::GetSerializedSize(), m_gtsFields, m_pndAddrFields, and m_superframeField.

+ Here is the call graph for this function:

◆ GetSuperframeSpecField()

SuperframeField ns3::BeaconPayloadHeader::GetSuperframeSpecField ( void  ) const

Get the superframe specification field from the beacon payload header.

Returns
The superframe specification field

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

References m_superframeField.

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

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::BeaconPayloadHeader::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 37 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::BeaconPayloadHeader::Print ( std::ostream &  os) const
virtual
Parameters
osoutput 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 86 of file lr-wpan-mac-pl-headers.cc.

References ns3::GtsFields::GetGtsSpecField(), ns3::PendingAddrFields::GetPndAddrSpecField(), m_gtsFields, m_pndAddrFields, and m_superframeField.

+ Here is the call graph for this function:

◆ Serialize()

void ns3::BeaconPayloadHeader::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan 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 65 of file lr-wpan-mac-pl-headers.cc.

References m_gtsFields, m_pndAddrFields, m_superframeField, ns3::SuperframeField::Serialize(), ns3::GtsFields::Serialize(), ns3::PendingAddrFields::Serialize(), and visualizer.core::start().

+ Here is the call graph for this function:

◆ SetGtsFields()

void ns3::BeaconPayloadHeader::SetGtsFields ( GtsFields  gtsFields)

Set the superframe Guaranteed Time Slot (GTS) fields to the beacon payload header.

Parameters
gtsFieldsThe GTS fields.

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

References m_gtsFields.

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

+ Here is the caller graph for this function:

◆ SetPndAddrFields()

void ns3::BeaconPayloadHeader::SetPndAddrFields ( PendingAddrFields  pndAddrFields)

Set the superframe Pending Address fields to the beacon payload header.

Parameters
pndAddrFieldsThe Pending Address fields.

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

References m_pndAddrFields.

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

+ Here is the caller graph for this function:

◆ SetSuperframeSpecField()

void ns3::BeaconPayloadHeader::SetSuperframeSpecField ( SuperframeField  sfrmField)

Set the superframe specification field to the beacon payload header.

Parameters
sfrmFieldThe superframe specification field

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

References m_superframeField.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_gtsFields

GtsFields ns3::BeaconPayloadHeader::m_gtsFields
private

GTS Fields.

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

Referenced by Deserialize(), GetGtsFields(), GetSerializedSize(), Print(), Serialize(), and SetGtsFields().

◆ m_pndAddrFields

PendingAddrFields ns3::BeaconPayloadHeader::m_pndAddrFields
private

◆ m_superframeField

SuperframeField ns3::BeaconPayloadHeader::m_superframeField
private

Superframe Specification Field.

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

Referenced by Deserialize(), GetSerializedSize(), GetSuperframeSpecField(), Print(), Serialize(), and SetSuperframeSpecField().


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