A broadcast Transaction Record (BTR) As described in Table 3-70. More...

#include "zigbee-nwk-tables.h"

Inheritance diagram for ns3::zigbee::BroadcastTransactionRecord:

Collaboration diagram for ns3::zigbee::BroadcastTransactionRecord:

Public Member Functions
	BroadcastTransactionRecord ()

	BroadcastTransactionRecord (Mac16Address srcAddr, uint8_t seq, Time exp)
	Construct a new Broadcast Transaction Record (BTR) entry.

	~BroadcastTransactionRecord ()

uint8_t	GetBcstRetryCount () const
	Get the broadcast retry count value.

Time	GetExpirationTime () const
	Get the value of the expiration time in the BTR.

uint8_t	GetSeqNum () const
	Get the sequence number of the BTR.

Mac16Address	GetSrcAddr () const
	Get the source address of the BTR.

void	Print (Ptr< OutputStreamWrapper > stream) const
	Print the values of the BTR.

void	SetBcstRetryCount (uint8_t count)
	Set the Broadcast retry count object.

void	SetExpirationTime (Time exp)
	Set the expiration time object.

void	SetSeqNum (uint8_t seq)
	Set the sequence number of the BTR.

void	SetSrcAddr (Mac16Address srcAddr)
	Set the source address of the BTR.

Public Member Functions inherited from ns3::SimpleRefCount< BroadcastTransactionRecord >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Private Attributes
uint8_t	m_broadcastRetryCount
	The number of times this BCST has been retried.

Time	m_expirationTime
	An indicator of when the entry expires.

uint8_t	m_sequenceNumber
	The RREQ sequence number of the initiator's broadcast.

Mac16Address	m_srcAddr
	The 16-bit network address of the broadcast initiator.

Detailed Description

A broadcast Transaction Record (BTR) As described in Table 3-70.

Definition at line 848 of file zigbee-nwk-tables.h.

Constructor & Destructor Documentation

◆ BroadcastTransactionRecord() [1/2]

ns3::zigbee::BroadcastTransactionRecord::BroadcastTransactionRecord ( )

Definition at line 1367 of file zigbee-nwk-tables.cc.

◆ ~BroadcastTransactionRecord()

ns3::zigbee::BroadcastTransactionRecord::~BroadcastTransactionRecord ( )

Definition at line 1371 of file zigbee-nwk-tables.cc.

◆ BroadcastTransactionRecord() [2/2]

ns3::zigbee::BroadcastTransactionRecord::BroadcastTransactionRecord	(	Mac16Address	srcAddr,
		uint8_t	seq,
		Time	exp )

Construct a new Broadcast Transaction Record (BTR) entry.

Parameters

srcAddr	The source address of the BTR.
seq	The sequence number of the BTR.
exp	The expiration time of the BTR.

Definition at line 1359 of file zigbee-nwk-tables.cc.

References m_broadcastRetryCount, m_expirationTime, m_sequenceNumber, and m_srcAddr.

Member Function Documentation

◆ GetBcstRetryCount()

uint8_t ns3::zigbee::BroadcastTransactionRecord::GetBcstRetryCount ( ) const

Get the broadcast retry count value.

Returns: The broadcast retry count value

Definition at line 1412 of file zigbee-nwk-tables.cc.

References m_broadcastRetryCount.

◆ GetExpirationTime()

Time ns3::zigbee::BroadcastTransactionRecord::GetExpirationTime ( ) const

Get the value of the expiration time in the BTR.

Returns: The expiration time

Definition at line 1400 of file zigbee-nwk-tables.cc.

References m_expirationTime.

◆ GetSeqNum()

uint8_t ns3::zigbee::BroadcastTransactionRecord::GetSeqNum ( ) const

Get the sequence number of the BTR.

Returns: The sequence number.

Definition at line 1388 of file zigbee-nwk-tables.cc.

References m_sequenceNumber.

◆ GetSrcAddr()

Mac16Address ns3::zigbee::BroadcastTransactionRecord::GetSrcAddr ( ) const

Get the source address of the BTR.

Returns: The source address.

Definition at line 1376 of file zigbee-nwk-tables.cc.

References m_srcAddr.

◆ Print()

void ns3::zigbee::BroadcastTransactionRecord::Print ( Ptr< OutputStreamWrapper > stream ) const

Print the values of the BTR.

Parameters

stream The stream object used to print.

Definition at line 1424 of file zigbee-nwk-tables.cc.

References m_broadcastRetryCount, m_expirationTime, m_sequenceNumber, m_srcAddr, ns3::Simulator::Now(), and ns3::Time::S.

Here is the call graph for this function:

◆ SetBcstRetryCount()

void ns3::zigbee::BroadcastTransactionRecord::SetBcstRetryCount ( uint8_t count )

Set the Broadcast retry count object.

Parameters

count The value of the counter

Definition at line 1418 of file zigbee-nwk-tables.cc.

References m_broadcastRetryCount.

◆ SetExpirationTime()

void ns3::zigbee::BroadcastTransactionRecord::SetExpirationTime ( Time exp )

Set the expiration time object.

Parameters

exp	The expiration time of the BTR

Definition at line 1406 of file zigbee-nwk-tables.cc.

References m_expirationTime.

◆ SetSeqNum()

void ns3::zigbee::BroadcastTransactionRecord::SetSeqNum ( uint8_t seq )

Set the sequence number of the BTR.

Parameters

seq	The sequence number of the BTR

Definition at line 1394 of file zigbee-nwk-tables.cc.

References m_sequenceNumber.

◆ SetSrcAddr()

void ns3::zigbee::BroadcastTransactionRecord::SetSrcAddr ( Mac16Address srcAddr )

Set the source address of the BTR.

Parameters

srcAddr The source address of the BTR

Definition at line 1382 of file zigbee-nwk-tables.cc.

References m_srcAddr.

Member Data Documentation

◆ m_broadcastRetryCount

uint8_t ns3::zigbee::BroadcastTransactionRecord::m_broadcastRetryCount

private

The number of times this BCST has been retried.

Definition at line 930 of file zigbee-nwk-tables.h.

Referenced by BroadcastTransactionRecord(), GetBcstRetryCount(), Print(), and SetBcstRetryCount().

◆ m_expirationTime

Time ns3::zigbee::BroadcastTransactionRecord::m_expirationTime

private

An indicator of when the entry expires.

Definition at line 929 of file zigbee-nwk-tables.h.

Referenced by BroadcastTransactionRecord(), GetExpirationTime(), Print(), and SetExpirationTime().

◆ m_sequenceNumber

uint8_t ns3::zigbee::BroadcastTransactionRecord::m_sequenceNumber

private

The RREQ sequence number of the initiator's broadcast.

Definition at line 928 of file zigbee-nwk-tables.h.

Referenced by BroadcastTransactionRecord(), GetSeqNum(), Print(), and SetSeqNum().

◆ m_srcAddr

Mac16Address ns3::zigbee::BroadcastTransactionRecord::m_srcAddr

private

The 16-bit network address of the broadcast initiator.

Definition at line 927 of file zigbee-nwk-tables.h.

Referenced by BroadcastTransactionRecord(), GetSrcAddr(), Print(), and SetSrcAddr().

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

src/zigbee/model/zigbee-nwk-tables.h
src/zigbee/model/zigbee-nwk-tables.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BroadcastTransactionRecord() [1/2]

◆ ~BroadcastTransactionRecord()

◆ BroadcastTransactionRecord() [2/2]

Member Function Documentation

◆ GetBcstRetryCount()

◆ GetExpirationTime()

◆ GetSeqNum()

◆ GetSrcAddr()

◆ Print()

◆ SetBcstRetryCount()

◆ SetExpirationTime()

◆ SetSeqNum()

◆ SetSrcAddr()

Member Data Documentation

◆ m_broadcastRetryCount

◆ m_expirationTime

◆ m_sequenceNumber

◆ m_srcAddr