A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::zigbee::ZigbeePayloadType Class Reference

Represent the static portion of the zigbee payload header that describes the payload command type. More...

#include "zigbee-nwk-payload-header.h"

+ Inheritance diagram for ns3::zigbee::ZigbeePayloadType:
+ Collaboration diagram for ns3::zigbee::ZigbeePayloadType:

Public Member Functions

 ZigbeePayloadType ()
 
 ZigbeePayloadType (enum NwkCommandType nwkCmd)
 Constructor.
 
uint32_t Deserialize (Buffer::Iterator start) override
 
NwkCommandType GetCmdType () const
 Get the command frame type.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
uint32_t GetSerializedSize () const override
 
void Print (std::ostream &os) const override
 
void Serialize (Buffer::Iterator start) const override
 
void SetCmdType (enum NwkCommandType nwkCmd)
 Set the command frame type.
 
- 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

NwkCommandType m_nwkCmdType
 The network command Type.
 

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.
 

Detailed Description

Represent the static portion of the zigbee payload header that describes the payload command type.

Definition at line 58 of file zigbee-nwk-payload-header.h.

Constructor & Destructor Documentation

◆ ZigbeePayloadType() [1/2]

ns3::zigbee::ZigbeePayloadType::ZigbeePayloadType ( )

Definition at line 24 of file zigbee-nwk-payload-header.cc.

References ns3::zigbee::LEAVE_CMD, and m_nwkCmdType.

◆ ZigbeePayloadType() [2/2]

ns3::zigbee::ZigbeePayloadType::ZigbeePayloadType ( enum NwkCommandType nwkCmd)

Constructor.

Parameters
nwkCmdthe command type of this command header

Definition at line 29 of file zigbee-nwk-payload-header.cc.

References m_nwkCmdType.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::zigbee::ZigbeePayloadType::Deserialize ( Buffer::Iterator start)
overridevirtual
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 76 of file zigbee-nwk-payload-header.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_nwkCmdType, and ns3::Buffer::Iterator::ReadU8().

+ Here is the call graph for this function:

◆ GetCmdType()

NwkCommandType ns3::zigbee::ZigbeePayloadType::GetCmdType ( ) const

Get the command frame type.

Returns
The command type from the command payload header

Definition at line 57 of file zigbee-nwk-payload-header.cc.

References m_nwkCmdType.

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

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::zigbee::ZigbeePayloadType::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 45 of file zigbee-nwk-payload-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::zigbee::ZigbeePayloadType::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 63 of file zigbee-nwk-payload-header.cc.

◆ GetTypeId()

TypeId ns3::zigbee::ZigbeePayloadType::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 35 of file zigbee-nwk-payload-header.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::zigbee::ZigbeePayloadType::Print ( std::ostream & os) const
overridevirtual
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 85 of file zigbee-nwk-payload-header.cc.

References ns3::zigbee::LEAVE_CMD, ns3::zigbee::LINK_POWER_DELTA_CMD, ns3::zigbee::LINK_STATUS_CMD, m_nwkCmdType, ns3::zigbee::NWK_REPORT_CMD, ns3::zigbee::NWK_STATUS_CMD, ns3::zigbee::NWK_UPDATE_CMD, ns3::zigbee::REJOIN_REQ_CMD, ns3::zigbee::REJOIN_RESP_CMD, ns3::zigbee::ROUTE_RECORD_CMD, ns3::zigbee::ROUTE_REP_CMD, ns3::zigbee::ROUTE_REQ_CMD, ns3::zigbee::TIMEOUT_REQ_CMD, and ns3::zigbee::TIMEOUT_RESP_CMD.

◆ Serialize()

void ns3::zigbee::ZigbeePayloadType::Serialize ( Buffer::Iterator start) const
overridevirtual
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 69 of file zigbee-nwk-payload-header.cc.

References m_nwkCmdType, and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

◆ SetCmdType()

void ns3::zigbee::ZigbeePayloadType::SetCmdType ( enum NwkCommandType nwkCmd)

Set the command frame type.

Parameters
nwkCmdthe command frame type

Definition at line 51 of file zigbee-nwk-payload-header.cc.

References m_nwkCmdType.

Member Data Documentation

◆ m_nwkCmdType

NwkCommandType ns3::zigbee::ZigbeePayloadType::m_nwkCmdType
private

The network command Type.

Definition at line 90 of file zigbee-nwk-payload-header.h.

Referenced by ZigbeePayloadType(), ZigbeePayloadType(), Deserialize(), GetCmdType(), Print(), Serialize(), and SetCmdType().


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