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.

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

Detailed Description

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

See Zigbee specification r22.1.0, Section 3.4.2

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

Constructor & Destructor Documentation

◆ ZigbeePayloadRouteReplyCommand()

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

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

References m_cmdOptMcst, m_cmdOptOrigIeeeAddr, m_cmdOptRespIeeeAddr, m_pathCost, and m_routeReqId.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Function Documentation

◆ Deserialize()

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

References ns3::Buffer::Iterator::GetDistanceFrom(), m_cmdOptMcst, 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 provided by ns3::Object::GetInstanceTypeId but classes which derive from ns3::ObjectBase directly have to implement it themselves. Typically, this method should simply return the output of GetTypeId().

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

Implements ns3::ObjectBase.

Definition at line 359 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 489 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 526 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 513 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 501 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 539 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 477 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 365 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 349 of file zigbee-nwk-payload-header.cc.

References ZigbeePayloadRouteReplyCommand(), and 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

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 450 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

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 384 of file zigbee-nwk-payload-header.cc.

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