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"
Public Member Functions | |
BeaconPayloadHeader () | |
uint32_t | Deserialize (Buffer::Iterator start) override |
GtsFields | GetGtsFields () const |
Get the Guaranteed Time Slots (GTS) fields from the beacon payload header. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
PendingAddrFields | GetPndAddrFields () const |
Get the pending address fields from the beacon payload header. | |
uint32_t | GetSerializedSize () const override |
uint16_t | GetSuperframeSpecField () const |
Get the superframe specification field from the beacon payload header. | |
void | Print (std::ostream &os) const override |
void | Serialize (Buffer::Iterator start) const override |
void | SetGtsFields (GtsFields gtsFields) |
Set the superframe Guaranteed Time Slot (GTS) fields to the beacon payload header. | |
void | SetPndAddrFields (PendingAddrFields pndAddrFields) |
Set the superframe Pending Address fields to the beacon payload header. | |
void | SetSuperframeSpecField (uint16_t sfrmField) |
Set the superframe specification field to the beacon payload header. | |
Public Member Functions inherited from ns3::Header | |
~Header () override | |
virtual uint32_t | Deserialize (Buffer::Iterator start, Buffer::Iterator end) |
Deserialize the object from a buffer iterator. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Header | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Chunk | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
GtsFields | m_gtsFields |
GTS Fields. | |
PendingAddrFields | m_pndAddrFields |
Pending Address Fields. | |
uint16_t | m_superframeField |
Superframe Specification Field. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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.
Group: LrWpan
Size of this type is 120 bytes (on a 64-bit architecture).
Definition at line 28 of file lr-wpan-mac-pl-headers.h.
ns3::lrwpan::BeaconPayloadHeader::BeaconPayloadHeader | ( | ) |
Definition at line 23 of file lr-wpan-mac-pl-headers.cc.
|
overridevirtual |
start | an iterator which points to where the header should read from. |
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 67 of file lr-wpan-mac-pl-headers.cc.
References ns3::lrwpan::GtsFields::Deserialize(), ns3::lrwpan::PendingAddrFields::Deserialize(), ns3::Buffer::Iterator::GetDistanceFrom(), m_gtsFields, m_pndAddrFields, m_superframeField, and ns3::Buffer::Iterator::ReadU16().
GtsFields ns3::lrwpan::BeaconPayloadHeader::GetGtsFields | ( | ) | const |
Get the Guaranteed Time Slots (GTS) fields from the beacon payload header.
Definition at line 110 of file lr-wpan-mac-pl-headers.cc.
References m_gtsFields.
Referenced by ns3::lrwpan::LrWpanMac::ReceiveBeacon().
|
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.
Implements ns3::ObjectBase.
Definition at line 41 of file lr-wpan-mac-pl-headers.cc.
References GetTypeId().
PendingAddrFields ns3::lrwpan::BeaconPayloadHeader::GetPndAddrFields | ( | ) | const |
Get the pending address fields from the beacon payload header.
Definition at line 116 of file lr-wpan-mac-pl-headers.cc.
References m_pndAddrFields.
Referenced by ns3::lrwpan::LrWpanMac::ReceiveBeacon().
|
overridevirtual |
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 47 of file lr-wpan-mac-pl-headers.cc.
References ns3::lrwpan::GtsFields::GetSerializedSize(), ns3::lrwpan::PendingAddrFields::GetSerializedSize(), m_gtsFields, m_pndAddrFields, and m_superframeField.
uint16_t ns3::lrwpan::BeaconPayloadHeader::GetSuperframeSpecField | ( | ) | const |
Get the superframe specification field from the beacon payload header.
Definition at line 104 of file lr-wpan-mac-pl-headers.cc.
References m_superframeField.
Referenced by ns3::lrwpan::LrWpanMac::ReceiveBeacon().
|
static |
Get the type ID.
Definition at line 30 of file lr-wpan-mac-pl-headers.cc.
References ns3::TypeId::AddDeprecatedName(), and ns3::TypeId::SetParent().
Referenced by GetInstanceTypeId().
|
overridevirtual |
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 78 of file lr-wpan-mac-pl-headers.cc.
References ns3::lrwpan::GtsFields::GetGtsSpecField(), ns3::lrwpan::PendingAddrFields::GetPndAddrSpecField(), m_gtsFields, m_pndAddrFields, and m_superframeField.
|
overridevirtual |
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 58 of file lr-wpan-mac-pl-headers.cc.
References m_gtsFields, m_pndAddrFields, m_superframeField, ns3::lrwpan::GtsFields::Serialize(), ns3::lrwpan::PendingAddrFields::Serialize(), and ns3::Buffer::Iterator::WriteU16().
void ns3::lrwpan::BeaconPayloadHeader::SetGtsFields | ( | GtsFields | gtsFields | ) |
Set the superframe Guaranteed Time Slot (GTS) fields to the beacon payload header.
gtsFields | The GTS fields. |
Definition at line 92 of file lr-wpan-mac-pl-headers.cc.
References m_gtsFields.
Referenced by ns3::lrwpan::LrWpanMac::SendOneBeacon().
void ns3::lrwpan::BeaconPayloadHeader::SetPndAddrFields | ( | PendingAddrFields | pndAddrFields | ) |
Set the superframe Pending Address fields to the beacon payload header.
pndAddrFields | The Pending Address fields. |
Definition at line 98 of file lr-wpan-mac-pl-headers.cc.
References m_pndAddrFields.
Referenced by ns3::lrwpan::LrWpanMac::SendOneBeacon().
void ns3::lrwpan::BeaconPayloadHeader::SetSuperframeSpecField | ( | uint16_t | sfrmField | ) |
Set the superframe specification field to the beacon payload header.
sfrmField | The superframe specification field (bitmap) |
Definition at line 86 of file lr-wpan-mac-pl-headers.cc.
References m_superframeField.
Referenced by ns3::lrwpan::LrWpanMac::SendOneBeacon().
|
private |
GTS Fields.
Definition at line 81 of file lr-wpan-mac-pl-headers.h.
Referenced by Deserialize(), GetGtsFields(), GetSerializedSize(), Print(), Serialize(), and SetGtsFields().
|
private |
Pending Address Fields.
Definition at line 85 of file lr-wpan-mac-pl-headers.h.
Referenced by Deserialize(), GetPndAddrFields(), GetSerializedSize(), Print(), Serialize(), and SetPndAddrFields().
|
private |
Superframe Specification Field.
Definition at line 77 of file lr-wpan-mac-pl-headers.h.
Referenced by Deserialize(), GetSerializedSize(), GetSuperframeSpecField(), Print(), Serialize(), and SetSuperframeSpecField().