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

Represent a variable portion of the zigbee payload header that includes the route reply command. More...

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

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

Public Member Functions

 ZigbeePayloadRouteReplyCommand ()
 
uint32_t Deserialize (Buffer::Iterator start) override
 
uint8_t GetCmdOption () const
 Get the command option.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
Mac16Address GetOrigAddr () const
 Get the Originator address.
 
Mac64Address GetOrigIeeeAddr () const
 Get the Originator IEEE address.
 
uint8_t GetPathCost () const
 Get the path cost.
 
Mac16Address GetRespAddr () const
 Get the Responder address.
 
Mac64Address GetRespIeeeAddr () const
 Get the Responder IEEE address.
 
uint8_t GetRouteReqId () const
 Get the Route request identifier.
 
uint32_t GetSerializedSize () const override
 
void Print (std::ostream &os) const override
 
void Serialize (Buffer::Iterator start) const override
 
void SetCmdOption (uint8_t option)
 Set the command option.
 
void SetOrigAddr (Mac16Address addr)
 Set Originator address.
 
void SetOrigIeeeAddr (Mac64Address orig)
 Set the Originator IEEE address.
 
void SetPathCost (uint8_t cost)
 Set the path cost.
 
void SetRespAddr (Mac16Address addr)
 Set Responder address.
 
void SetRespIeeeAddr (Mac64Address resp)
 Set the Responder IEEE address.
 
void SetRouteReqId (uint8_t rid)
 Set the Route request identifier.
 
- 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

bool m_cmdOptMcst
 Multicast flag (Bit 6)
 
bool m_cmdOptOrigIeeeAddr
 Originator IEEE address flag (Bit 4)
 
bool m_cmdOptRespIeeeAddr
 Responder IEEE address flag (Bit 5)
 
Mac16Address m_origAddr
 Originator address (2 Octets)
 
Mac64Address m_origIeeeAddr
 Originator IEEE address (0-8 Octets)
 
uint8_t m_pathCost
 Path cost (1 Octet)
 
Mac16Address m_respAddr
 Responder address (2 Octets)
 
Mac64Address m_respIeeeAddr
 Responder IEEE address (0-8 Octets)
 
uint8_t m_routeReqId
 Route request identifier (1 Octet)
 

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 a variable portion of the zigbee payload header that includes the route reply command.

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

Constructor & Destructor Documentation

◆ ZigbeePayloadRouteReplyCommand()

ns3::zigbee::ZigbeePayloadRouteReplyCommand::ZigbeePayloadRouteReplyCommand ( )

Member Function Documentation

◆ Deserialize()

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

References ns3::Buffer::Iterator::GetDistanceFrom(), m_cmdOptOrigIeeeAddr, m_cmdOptRespIeeeAddr, m_origAddr, m_origIeeeAddr, m_pathCost, m_respAddr, m_respIeeeAddr, m_routeReqId, ns3::ReadFrom(), and ns3::Buffer::Iterator::ReadU8().

+ Here is the call graph for this function:

◆ GetCmdOption()

uint8_t ns3::zigbee::ZigbeePayloadRouteReplyCommand::GetCmdOption ( ) const

Get the command option.

Returns
the command option

◆ GetInstanceTypeId()

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

References GetTypeId().

+ Here is the call graph for this function:

◆ GetOrigAddr()

Mac16Address ns3::zigbee::ZigbeePayloadRouteReplyCommand::GetOrigAddr ( ) const

Get the Originator address.

Returns
the originator address (16bits)

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

References m_origAddr.

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

+ Here is the caller graph for this function:

◆ GetOrigIeeeAddr()

Mac64Address ns3::zigbee::ZigbeePayloadRouteReplyCommand::GetOrigIeeeAddr ( ) const

Get the Originator IEEE address.

Returns
The originator IEEE address (64bits)

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

References m_origIeeeAddr.

◆ GetPathCost()

uint8_t ns3::zigbee::ZigbeePayloadRouteReplyCommand::GetPathCost ( ) const

Get the path cost.

Returns
the path cost

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

References m_pathCost.

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

+ Here is the caller graph for this function:

◆ GetRespAddr()

Mac16Address ns3::zigbee::ZigbeePayloadRouteReplyCommand::GetRespAddr ( ) const

Get the Responder address.

Returns
the responder address (16bits)

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

References m_respAddr.

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

+ Here is the caller graph for this function:

◆ GetRespIeeeAddr()

Mac64Address ns3::zigbee::ZigbeePayloadRouteReplyCommand::GetRespIeeeAddr ( ) const

Get the Responder IEEE address.

Returns
The responder IEEE address (64bits)

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

References m_respIeeeAddr.

◆ GetRouteReqId()

uint8_t ns3::zigbee::ZigbeePayloadRouteReplyCommand::GetRouteReqId ( ) const

Get the Route request identifier.

Returns
the Radius

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

References m_routeReqId.

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

+ Here is the caller graph for this function:

◆ GetSerializedSize()

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

References m_cmdOptOrigIeeeAddr, and m_cmdOptRespIeeeAddr.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 337 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::ZigbeePayloadRouteReplyCommand::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 412 of file zigbee-nwk-payload-header.cc.

References m_cmdOptOrigIeeeAddr, m_cmdOptRespIeeeAddr, m_origAddr, m_origIeeeAddr, m_pathCost, m_respAddr, m_respIeeeAddr, and m_routeReqId.

◆ Serialize()

void ns3::zigbee::ZigbeePayloadRouteReplyCommand::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 372 of file zigbee-nwk-payload-header.cc.

References m_cmdOptOrigIeeeAddr, m_cmdOptRespIeeeAddr, m_origAddr, m_origIeeeAddr, m_pathCost, m_respAddr, m_respIeeeAddr, m_routeReqId, ns3::WriteTo(), and ns3::Buffer::Iterator::WriteU8().

+ Here is the call graph for this function:

◆ SetCmdOption()

void ns3::zigbee::ZigbeePayloadRouteReplyCommand::SetCmdOption ( uint8_t option)

Set the command option.

Parameters
optionthe command option

◆ SetOrigAddr()

void ns3::zigbee::ZigbeePayloadRouteReplyCommand::SetOrigAddr ( Mac16Address addr)

Set Originator address.

Parameters
addrThe originator address (16 bit)

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

References m_origAddr.

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

+ Here is the caller graph for this function:

◆ SetOrigIeeeAddr()

void ns3::zigbee::ZigbeePayloadRouteReplyCommand::SetOrigIeeeAddr ( Mac64Address orig)

Set the Originator IEEE address.

Parameters
origThe originator IEEE address (64 bits)

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

References m_cmdOptOrigIeeeAddr, and m_origIeeeAddr.

◆ SetPathCost()

void ns3::zigbee::ZigbeePayloadRouteReplyCommand::SetPathCost ( uint8_t cost)

Set the path cost.

Parameters
costthe path cost

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

References m_pathCost.

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

+ Here is the caller graph for this function:

◆ SetRespAddr()

void ns3::zigbee::ZigbeePayloadRouteReplyCommand::SetRespAddr ( Mac16Address addr)

Set Responder address.

Parameters
addrthe responder address (16 bit)

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

References m_respAddr.

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

+ Here is the caller graph for this function:

◆ SetRespIeeeAddr()

void ns3::zigbee::ZigbeePayloadRouteReplyCommand::SetRespIeeeAddr ( Mac64Address resp)

Set the Responder IEEE address.

Parameters
respThe responder IEEE address (64 bits)

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

References m_cmdOptRespIeeeAddr, and m_respIeeeAddr.

◆ SetRouteReqId()

void ns3::zigbee::ZigbeePayloadRouteReplyCommand::SetRouteReqId ( uint8_t rid)

Set the Route request identifier.

Parameters
ridthe route request identifier

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

References m_routeReqId.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_cmdOptMcst

bool ns3::zigbee::ZigbeePayloadRouteReplyCommand::m_cmdOptMcst
private

Multicast flag (Bit 6)

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

Referenced by ZigbeePayloadRouteReplyCommand().

◆ m_cmdOptOrigIeeeAddr

bool ns3::zigbee::ZigbeePayloadRouteReplyCommand::m_cmdOptOrigIeeeAddr
private

Originator IEEE address flag (Bit 4)

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

Referenced by ZigbeePayloadRouteReplyCommand(), Deserialize(), GetSerializedSize(), Print(), Serialize(), and SetOrigIeeeAddr().

◆ m_cmdOptRespIeeeAddr

bool ns3::zigbee::ZigbeePayloadRouteReplyCommand::m_cmdOptRespIeeeAddr
private

Responder IEEE address flag (Bit 5)

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

Referenced by ZigbeePayloadRouteReplyCommand(), Deserialize(), GetSerializedSize(), Print(), Serialize(), and SetRespIeeeAddr().

◆ m_origAddr

Mac16Address ns3::zigbee::ZigbeePayloadRouteReplyCommand::m_origAddr
private

Originator address (2 Octets)

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

Referenced by Deserialize(), GetOrigAddr(), Print(), Serialize(), and SetOrigAddr().

◆ m_origIeeeAddr

Mac64Address ns3::zigbee::ZigbeePayloadRouteReplyCommand::m_origIeeeAddr
private

Originator IEEE address (0-8 Octets)

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

Referenced by Deserialize(), GetOrigIeeeAddr(), Print(), Serialize(), and SetOrigIeeeAddr().

◆ m_pathCost

uint8_t ns3::zigbee::ZigbeePayloadRouteReplyCommand::m_pathCost
private

Path cost (1 Octet)

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

Referenced by ZigbeePayloadRouteReplyCommand(), Deserialize(), GetPathCost(), Print(), Serialize(), and SetPathCost().

◆ m_respAddr

Mac16Address ns3::zigbee::ZigbeePayloadRouteReplyCommand::m_respAddr
private

Responder address (2 Octets)

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

Referenced by Deserialize(), GetRespAddr(), Print(), Serialize(), and SetRespAddr().

◆ m_respIeeeAddr

Mac64Address ns3::zigbee::ZigbeePayloadRouteReplyCommand::m_respIeeeAddr
private

Responder IEEE address (0-8 Octets)

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

Referenced by Deserialize(), GetRespIeeeAddr(), Print(), Serialize(), and SetRespIeeeAddr().

◆ m_routeReqId

uint8_t ns3::zigbee::ZigbeePayloadRouteReplyCommand::m_routeReqId
private

Route request identifier (1 Octet)

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

Referenced by ZigbeePayloadRouteReplyCommand(), Deserialize(), GetRouteReqId(), Print(), Serialize(), and SetRouteReqId().


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