The Network layer Neighbor Table Entry See Zigbee specification r22.1.0, Table 3-63. More...

#include "zigbee-nwk-tables.h"

Inheritance diagram for ns3::zigbee::NeighborTableEntry:

Collaboration diagram for ns3::zigbee::NeighborTableEntry:

Public Member Functions
	NeighborTableEntry ()

	NeighborTableEntry (Mac64Address extAddr, Mac16Address nwkAddr, NwkDeviceType deviceType, bool rxOnWhenIdle, uint16_t endDevConfig, Time timeoutCounter, Time devTimeout, Relationship relationship, uint8_t txFailure, uint8_t lqi, uint8_t outgoingCost, uint8_t age, bool keepaliveRx, uint8_t macInterfaceIndex)
	Construct a new Neighbor Table Entry object.

	~NeighborTableEntry ()

uint8_t	GetAge () const
	Get the number of nwkLinkStatusPeriod intervals since the link status command was received.

uint8_t	GetBeaconOrder () const
	Get the value of the beacon order set in this neighbor.

uint64_t	GetBeaconTxTimeOffset () const
	Get the transmission time difference in symbols, between the neighbor's beacon and its parent beacon.

uint8_t	GetDepth () const
	The depth of the neighbor device.

NwkDeviceType	GetDeviceType () const
	Get the device type of this neighbor device.

Time	GetDevTimeout () const
	Get the device timeout object.

uint16_t	GetEndDevConfig () const
	Get the end device configuration object.

Mac64Address	GetExtAddr () const
	Get the entry registered IEEE address (EUI-64 address).

uint64_t	GetExtPanId () const
	Get the extended PAN identifier.

uint64_t	GetIncBeaconTimestamp () const
	Get the time in symbols at which the last beacon frame was received from the neighbor.

uint8_t	GetLogicalCh () const
	Get the logical channel used by the the neighbor in this entry.

uint8_t	GetLqi () const
	Get the LQI value from this device to an entry neighbor.

uint8_t	GetMacInterfaceIndex () const
	Get the MAC Interface Index object.

uint32_t	GetMacUcstBytesRx () const
	Get the number of unicast bytes received to the neighbor registered in this entry.

uint32_t	GetMacUcstBytesTx () const
	Get the number of unicast bytes transmitted to the neighbor registered in this entry.

Mac16Address	GetNwkAddr () const
	Get the entry registered Network address (MAC short address).

uint8_t	GetOutgoingCost () const
	Get the outgoing cost object.

uint8_t	GetRelationship () const
	Get the relationship object.

Time	GetTimeoutCounter () const
	Get the timeout counter object.

uint8_t	GetTxFailure () const
	Get the Tx Failure object.

uint8_t	IsPotentialParent () const
	Get the the value of the potential parent field.

bool	IsRxOnWhenIdle () const
	Return true is neighboring device is on when idle.

void	Print (Ptr< OutputStreamWrapper > stream) const
	Print the values of the neighbor table entry.

void	SetAge (uint8_t age)
	Set the number of nwkLinkStatusPeriod intervals since the link status command was received.

void	SetBeaconOrder (uint8_t bo)
	Set the value of the beacon order set in this neighbor.

void	SetBeaconTxTimeOffset (uint64_t offset)
	Set the transmission time difference in symbols, between the neighbor's beacon and its parent beacon.

void	SetDepth (uint8_t depth)
	Set the depth of the neighbor device.

void	SetDeviceType (NwkDeviceType devType)
	Set the device type of this neighbor device.

void	SetDevTimeout (Time timeout)
	Set the device timeout object.

void	SetEndDevConfig (uint16_t conf)
	Set the end device configuration.

void	SetExtPanId (uint64_t extPanId)
	Set the extended PAN identifier.

void	SetIncBeaconTimestamp (uint64_t timestamp)
	Set the time in symbols at which the last beacon frame was received from the neighbor.

void	SetLogicalCh (uint8_t channel)
	Set the logical channel used by the the neighbor in this entry.

void	SetLqi (uint8_t lqi)
	Set the Link quality indicator value from this device to an entry neighbor.

void	SetMacInterfaceIndex (uint8_t index)
	Set the MAC Interface Index object.

void	SetMacUcstBytesRx (uint32_t rxBytes)
	Set the number of unicast bytes received to the neighbor registered in this entry.

void	SetMacUcstBytesTx (uint32_t txBytes)
	Set the number of unicast bytes transmitted to the neighbor registered in this entry.

void	SetNwkAddr (Mac16Address nwkAddr)
	Set the entry registered Network address (MAC short address).

void	SetOutgoingCost (uint8_t cost)
	Set the outgoing cost object.

void	SetPotentialParent (bool confirm)
	Set the the value of the potential parent field.

void	SetRelationship (Relationship relationship)
	Set the relationship object.

void	SetRxOnWhenIdle (bool onWhenIdle)
	Set the device is on when idle flag.

void	SetTimeoutCounter (Time counter)
	Set the timeout counter object.

void	SetTxFailure (uint8_t failure)
	Set the Tx Failure object.

Public Member Functions inherited from ns3::SimpleRefCount< NeighborTableEntry >
	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_age
	The number of nwkLinkStatusPeriod intervals since link status command was received.

uint64_t	m_beaconTxTimeOffset
	The transmission time difference in symbols, between the neighbor's beacon and its parent beacon (Optional field).

uint8_t	m_bo {15}
	The beacon order of the device (See IEEE 802.15.4-2011)

uint8_t	m_depth
	The tree depth of the neighbor device.

NwkDeviceType	m_deviceType
	The type of neighbor device.

Time	m_devTimeout
	This field indicates the timeout, in seconds, for the end device child.

uint16_t	m_endDevConfig
	The end device configuration.

Mac64Address	m_extAddr
	The IEEE EUI-64 bit address that is unique to every device.

uint64_t	m_extPanId
	The extendend PAN id (based on the Zigbee coordinator EUI-64 address)

uint64_t	m_incBeaconTimestamp
	The time in symbols at which the last beacon frame was received from the neighbor.

bool	m_keepaliveRx
	This value indicates at least one keepalive has been received from the end device since the router has rebooted.

uint8_t	m_logicalCh
	The logical channel on which the network is operating.

uint8_t	m_lqi
	The estimated link quality for RF transmissions from this device See Zigbee specification r22.1.0, 3.6.3.1.

uint8_t	m_macInterfaceIndex
	This is an index into the MAC Interface Table indicating what interface the neighbor or child is bound to.

uint32_t	m_macUcstBytesRx
	The number of bytes received via MAC unicasts from this neighbor (Optional field).

uint32_t	m_macUcstBytesTx
	The number of bytes transmitted via MAC unicast to the neighbor (Optional field).

Mac16Address	m_nwkAddr
	The 16 bit network address of the neighboring device.

uint8_t	m_outgoingCost
	The cost of the outgoing link as measured by the neighbor.

bool	m_potentialParent {true}
	An indication of whether the device has been ruled out as a potential parent.

Relationship	m_relationship
	Relationship between the neighbor and the current device.

bool	m_rxOnWhenIdle
	Indicates if the neighbor receiver is enabled during idle periods.

Time	m_timeoutCounter
	Indicates the current time remaining in seconds, for the end device.

uint8_t	m_txFailure
	A value indicating if previous transmissions to the device were successful or not.

Detailed Description

The Network layer Neighbor Table Entry See Zigbee specification r22.1.0, Table 3-63.

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

Constructor & Destructor Documentation

◆ NeighborTableEntry() [1/2]

ns3::zigbee::NeighborTableEntry::NeighborTableEntry ( )

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

◆ ~NeighborTableEntry()

ns3::zigbee::NeighborTableEntry::~NeighborTableEntry ( )

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

◆ NeighborTableEntry() [2/2]

ns3::zigbee::NeighborTableEntry::NeighborTableEntry	(	Mac64Address	extAddr,
		Mac16Address	nwkAddr,
		NwkDeviceType	deviceType,
		bool	rxOnWhenIdle,
		uint16_t	endDevConfig,
		Time	timeoutCounter,
		Time	devTimeout,
		Relationship	relationship,
		uint8_t	txFailure,
		uint8_t	lqi,
		uint8_t	outgoingCost,
		uint8_t	age,
		bool	keepaliveRx,
		uint8_t	macInterfaceIndex )

Construct a new Neighbor Table Entry object.

This constructor do not include the optional or additional fields.

Parameters

extAddr	The EUI-64 address of the device to register (IEEEaddress)
nwkAddr	The short address of the device to register (The MAC 16 address)
deviceType	The type of neighbor device
rxOnWhenIdle	Indication of whether the neighbor enabled during idle periods.
endDevConfig	The end device configuration
timeoutCounter	The remaining current time in seconds.
devTimeout	The timeout in seconds of the end device
relationship	The relationship between the neighbor and the current device
txFailure	Indicates whether or not a previous Tx to the device was successful.
lqi	The link quality indicator (LQI) value
outgoingCost	Cost of the link measured by the neighbor
age	Num of nwkLinkStatusPeriods since the link status cmd was received.
keepaliveRx	Indicates if at least one keep alive was received since the router was rebooted.
macInterfaceIndex	The MAC interface index

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

References m_age, m_deviceType, m_devTimeout, m_endDevConfig, m_extAddr, m_keepaliveRx, m_lqi, m_macInterfaceIndex, m_nwkAddr, m_outgoingCost, m_relationship, m_rxOnWhenIdle, m_timeoutCounter, and m_txFailure.

Member Function Documentation

◆ GetAge()

uint8_t ns3::zigbee::NeighborTableEntry::GetAge ( ) const

Get the number of nwkLinkStatusPeriod intervals since the link status command was received.

Returns: The number of nwkLinkStatusPeriod intervals

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

References m_age.

◆ GetBeaconOrder()

uint8_t ns3::zigbee::NeighborTableEntry::GetBeaconOrder ( ) const

Get the value of the beacon order set in this neighbor.

See IEEE 802.15.4-2011.

Returns: The value of the beacon order registered for this neighbor entry.

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

References m_bo.

◆ GetBeaconTxTimeOffset()

uint64_t ns3::zigbee::NeighborTableEntry::GetBeaconTxTimeOffset ( ) const

Get the transmission time difference in symbols, between the neighbor's beacon and its parent beacon.

Returns: Time difference (symbols) between beacon and parent beacon.

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

References m_beaconTxTimeOffset.

◆ GetDepth()

uint8_t ns3::zigbee::NeighborTableEntry::GetDepth ( ) const

The depth of the neighbor device.

Returns: The depth of the neighbor device in this entryj

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

References m_depth.

◆ GetDeviceType()

NwkDeviceType ns3::zigbee::NeighborTableEntry::GetDeviceType ( ) const

Get the device type of this neighbor device.

Returns: The type of device registered for this neighbor.

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

References m_deviceType.

◆ GetDevTimeout()

Time ns3::zigbee::NeighborTableEntry::GetDevTimeout ( ) const

Get the device timeout object.

Returns: The device timeout time

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

References m_devTimeout, and ns3::Simulator::Now().

Here is the call graph for this function:

◆ GetEndDevConfig()

uint16_t ns3::zigbee::NeighborTableEntry::GetEndDevConfig ( ) const

Get the end device configuration object.

Returns: The end device configuration in this entry.

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

References m_endDevConfig.

◆ GetExtAddr()

Mac64Address ns3::zigbee::NeighborTableEntry::GetExtAddr ( ) const

Get the entry registered IEEE address (EUI-64 address).

Returns: The entry EUI-64 address.

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

References m_extAddr.

◆ GetExtPanId()

uint64_t ns3::zigbee::NeighborTableEntry::GetExtPanId ( ) const

Get the extended PAN identifier.

Returns: The extended PAN identifier.

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

References m_extPanId.

◆ GetIncBeaconTimestamp()

uint64_t ns3::zigbee::NeighborTableEntry::GetIncBeaconTimestamp ( ) const

Get the time in symbols at which the last beacon frame was received from the neighbor.

Returns: time in symbols since last beacon frame.

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

References m_incBeaconTimestamp.

◆ GetLogicalCh()

uint8_t ns3::zigbee::NeighborTableEntry::GetLogicalCh ( ) const

Get the logical channel used by the the neighbor in this entry.

Returns: The channel number used by this neighbor.

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

References m_logicalCh.

◆ GetLqi()

uint8_t ns3::zigbee::NeighborTableEntry::GetLqi ( ) const

Get the LQI value from this device to an entry neighbor.

Returns: The LQI value

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

References m_lqi.

◆ GetMacInterfaceIndex()

uint8_t ns3::zigbee::NeighborTableEntry::GetMacInterfaceIndex ( ) const

Get the MAC Interface Index object.

Returns: The MAC interface index registered for this entry

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

References m_macInterfaceIndex.

◆ GetMacUcstBytesRx()

uint32_t ns3::zigbee::NeighborTableEntry::GetMacUcstBytesRx ( ) const

Get the number of unicast bytes received to the neighbor registered in this entry.

Returns: Unicast transmitted bytes.

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

References m_macUcstBytesRx.

◆ GetMacUcstBytesTx()

uint32_t ns3::zigbee::NeighborTableEntry::GetMacUcstBytesTx ( ) const

Get the number of unicast bytes transmitted to the neighbor registered in this entry.

Returns: Unicast transmitted bytes.

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

References m_macUcstBytesTx.

◆ GetNwkAddr()

Mac16Address ns3::zigbee::NeighborTableEntry::GetNwkAddr ( ) const

Get the entry registered Network address (MAC short address).

Returns: The 16 bit address registered in this entry.

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

References m_nwkAddr.

◆ GetOutgoingCost()

uint8_t ns3::zigbee::NeighborTableEntry::GetOutgoingCost ( ) const

Get the outgoing cost object.

Returns: The cost of the outgoing link as measured by a neighbor.

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

References m_outgoingCost.

◆ GetRelationship()

uint8_t ns3::zigbee::NeighborTableEntry::GetRelationship ( ) const

Get the relationship object.

Returns: The relationship between the neighbor and current device.

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

References m_relationship.

◆ GetTimeoutCounter()

Time ns3::zigbee::NeighborTableEntry::GetTimeoutCounter ( ) const

Get the timeout counter object.

Returns: The extended PAN Id registered to this entry.

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

References m_timeoutCounter.

◆ GetTxFailure()

uint8_t ns3::zigbee::NeighborTableEntry::GetTxFailure ( ) const

Get the Tx Failure object.

Returns: A value indicating if a prev Tx to the device was successful.

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

References m_txFailure.

◆ IsPotentialParent()

uint8_t ns3::zigbee::NeighborTableEntry::IsPotentialParent ( ) const

Get the the value of the potential parent field.

Returns: A confirmation of whether of not the device has been discarded a potential parent.

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

References m_potentialParent.

◆ IsRxOnWhenIdle()

bool ns3::zigbee::NeighborTableEntry::IsRxOnWhenIdle ( ) const

Return true is neighboring device is on when idle.

Returns: True if device is on when idle.

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

References m_rxOnWhenIdle.

◆ Print()

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

Print the values of the neighbor table entry.

Parameters

stream The stream object used to print.

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

References m_age, m_deviceType, m_devTimeout, m_extAddr, m_extPanId, m_lqi, m_nwkAddr, m_outgoingCost, m_potentialParent, m_relationship, m_txFailure, ns3::zigbee::NBR_CHILD, ns3::zigbee::NBR_NONE, ns3::zigbee::NBR_PARENT, ns3::zigbee::NBR_PREV_CHILD, ns3::zigbee::NBR_SIBLING, ns3::zigbee::NBR_UNAUTH_CHILD, ns3::zigbee::ZIGBEE_COORDINATOR, ns3::zigbee::ZIGBEE_ENDDEVICE, and ns3::zigbee::ZIGBEE_ROUTER.

◆ SetAge()

void ns3::zigbee::NeighborTableEntry::SetAge ( uint8_t age )

Set the number of nwkLinkStatusPeriod intervals since the link status command was received.

Parameters

age	The number of nwkLinkStatusPeriod intervals

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

References m_age.

◆ SetBeaconOrder()

void ns3::zigbee::NeighborTableEntry::SetBeaconOrder ( uint8_t bo )

Set the value of the beacon order set in this neighbor.

See IEEE 802.15.4-2011.

Parameters

bo	The value of the beacon order registered for this neighbor entry.

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

References m_bo.

◆ SetBeaconTxTimeOffset()

void ns3::zigbee::NeighborTableEntry::SetBeaconTxTimeOffset ( uint64_t offset )

Set the transmission time difference in symbols, between the neighbor's beacon and its parent beacon.

Parameters

offset Time difference (symbols) between beacon and parent beacon.

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

References m_beaconTxTimeOffset.

◆ SetDepth()

void ns3::zigbee::NeighborTableEntry::SetDepth ( uint8_t depth )

Set the depth of the neighbor device.

Parameters

depth The depth of the neighbor device in this entryj

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

References m_depth.

◆ SetDeviceType()

void ns3::zigbee::NeighborTableEntry::SetDeviceType ( NwkDeviceType devType )

Set the device type of this neighbor device.

Parameters

devType The device to set for this entry.

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

References m_deviceType.

◆ SetDevTimeout()

void ns3::zigbee::NeighborTableEntry::SetDevTimeout ( Time timeout )

Set the device timeout object.

Parameters

timeout The device timeout time

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

References m_devTimeout, and timeout.

◆ SetEndDevConfig()

void ns3::zigbee::NeighborTableEntry::SetEndDevConfig ( uint16_t conf )

Set the end device configuration.

Parameters

conf	The end device configuration to set in this entry.

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

References m_endDevConfig.

◆ SetExtPanId()

void ns3::zigbee::NeighborTableEntry::SetExtPanId ( uint64_t extPanId )

Set the extended PAN identifier.

Parameters

extPanId The extended PAN identifier.

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

References m_extPanId.

◆ SetIncBeaconTimestamp()

void ns3::zigbee::NeighborTableEntry::SetIncBeaconTimestamp ( uint64_t timestamp )

Set the time in symbols at which the last beacon frame was received from the neighbor.

Parameters

timestamp time in symbols since last beacon frame.

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

References m_incBeaconTimestamp.

◆ SetLogicalCh()

void ns3::zigbee::NeighborTableEntry::SetLogicalCh ( uint8_t channel )

Set the logical channel used by the the neighbor in this entry.

Parameters

channel The channel number used by this neighbor.

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

References m_logicalCh.

◆ SetLqi()

void ns3::zigbee::NeighborTableEntry::SetLqi ( uint8_t lqi )

Set the Link quality indicator value from this device to an entry neighbor.

Parameters

lqi	The LQI value

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

References m_lqi.

◆ SetMacInterfaceIndex()

void ns3::zigbee::NeighborTableEntry::SetMacInterfaceIndex ( uint8_t index )

Set the MAC Interface Index object.

Parameters

index The MAC interface index registered for this entry

◆ SetMacUcstBytesRx()

void ns3::zigbee::NeighborTableEntry::SetMacUcstBytesRx ( uint32_t rxBytes )

Set the number of unicast bytes received to the neighbor registered in this entry.

Parameters

rxBytes Unicast transmitted bytes.

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

References m_macUcstBytesRx.

◆ SetMacUcstBytesTx()

void ns3::zigbee::NeighborTableEntry::SetMacUcstBytesTx ( uint32_t txBytes )

Set the number of unicast bytes transmitted to the neighbor registered in this entry.

Parameters

txBytes Unicast transmitted bytes.

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

References m_macUcstBytesTx.

◆ SetNwkAddr()

void ns3::zigbee::NeighborTableEntry::SetNwkAddr ( Mac16Address nwkAddr )

Set the entry registered Network address (MAC short address).

Parameters

nwkAddr The 16 bit address to set in this entry.

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

References m_nwkAddr.

◆ SetOutgoingCost()

void ns3::zigbee::NeighborTableEntry::SetOutgoingCost ( uint8_t cost )

Set the outgoing cost object.

Parameters

cost	The cost of the outgoing link as measured by a neighbor.

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

References m_outgoingCost.

◆ SetPotentialParent()

void ns3::zigbee::NeighborTableEntry::SetPotentialParent ( bool confirm )

Set the the value of the potential parent field.

Parameters

confirm A confirm of whether or not the device has been discarded a potential parent.

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

References m_potentialParent.

◆ SetRelationship()

void ns3::zigbee::NeighborTableEntry::SetRelationship ( Relationship relationship )

Set the relationship object.

Parameters

relationship The relationship between the neighbor and current device.

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

References m_relationship.

◆ SetRxOnWhenIdle()

void ns3::zigbee::NeighborTableEntry::SetRxOnWhenIdle ( bool onWhenIdle )

Set the device is on when idle flag.

Parameters

onWhenIdle Set if device is on when idle.

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

References m_rxOnWhenIdle.

◆ SetTimeoutCounter()

void ns3::zigbee::NeighborTableEntry::SetTimeoutCounter ( Time counter )

Set the timeout counter object.

Parameters

counter The timeout counter used by this entry.

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

References m_timeoutCounter.

◆ SetTxFailure()

void ns3::zigbee::NeighborTableEntry::SetTxFailure ( uint8_t failure )

Set the Tx Failure object.

Parameters

failure A value indicating if a prev Tx to the device was successful.

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

References m_txFailure.

Member Data Documentation

◆ m_age

uint8_t ns3::zigbee::NeighborTableEntry::m_age

private

The number of nwkLinkStatusPeriod intervals since link status command was received.

Mandatory if m_nwkSymLink = true

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

Referenced by NeighborTableEntry(), GetAge(), Print(), and SetAge().

◆ m_beaconTxTimeOffset

uint64_t ns3::zigbee::NeighborTableEntry::m_beaconTxTimeOffset

private

The transmission time difference in symbols, between the neighbor's beacon and its parent beacon (Optional field).

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

Referenced by GetBeaconTxTimeOffset(), and SetBeaconTxTimeOffset().

◆ m_bo

uint8_t ns3::zigbee::NeighborTableEntry::m_bo {15}

private

The beacon order of the device (See IEEE 802.15.4-2011)

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

Referenced by GetBeaconOrder(), and SetBeaconOrder().

◆ m_depth

uint8_t ns3::zigbee::NeighborTableEntry::m_depth

private

The tree depth of the neighbor device.

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

Referenced by GetDepth(), and SetDepth().

◆ m_deviceType

NwkDeviceType ns3::zigbee::NeighborTableEntry::m_deviceType

private

The type of neighbor device.

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

Referenced by NeighborTableEntry(), GetDeviceType(), Print(), and SetDeviceType().

◆ m_devTimeout

Time ns3::zigbee::NeighborTableEntry::m_devTimeout

private

This field indicates the timeout, in seconds, for the end device child.

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

Referenced by NeighborTableEntry(), GetDevTimeout(), Print(), and SetDevTimeout().

◆ m_endDevConfig

uint16_t ns3::zigbee::NeighborTableEntry::m_endDevConfig

private

The end device configuration.

See Zigbee Specification r22.1.0, 3.4.11.3.2

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

Referenced by NeighborTableEntry(), GetEndDevConfig(), and SetEndDevConfig().

◆ m_extAddr

Mac64Address ns3::zigbee::NeighborTableEntry::m_extAddr

private

The IEEE EUI-64 bit address that is unique to every device.

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

Referenced by NeighborTableEntry(), GetExtAddr(), and Print().

◆ m_extPanId

uint64_t ns3::zigbee::NeighborTableEntry::m_extPanId

private

The extendend PAN id (based on the Zigbee coordinator EUI-64 address)

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

Referenced by GetExtPanId(), Print(), and SetExtPanId().

◆ m_incBeaconTimestamp

uint64_t ns3::zigbee::NeighborTableEntry::m_incBeaconTimestamp

private

The time in symbols at which the last beacon frame was received from the neighbor.

This is equal to the timestamp taken when the beacon frame was received (Optional Field) See IEEE 802.15.4-2015[B1]

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

Referenced by GetIncBeaconTimestamp(), and SetIncBeaconTimestamp().

◆ m_keepaliveRx

bool ns3::zigbee::NeighborTableEntry::m_keepaliveRx

private

This value indicates at least one keepalive has been received from the end device since the router has rebooted.

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

Referenced by NeighborTableEntry().

◆ m_logicalCh

uint8_t ns3::zigbee::NeighborTableEntry::m_logicalCh

private

The logical channel on which the network is operating.

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

Referenced by GetLogicalCh(), and SetLogicalCh().

◆ m_lqi

uint8_t ns3::zigbee::NeighborTableEntry::m_lqi

private

The estimated link quality for RF transmissions from this device See Zigbee specification r22.1.0, 3.6.3.1.

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

Referenced by NeighborTableEntry(), GetLqi(), Print(), and SetLqi().

◆ m_macInterfaceIndex

uint8_t ns3::zigbee::NeighborTableEntry::m_macInterfaceIndex

private

This is an index into the MAC Interface Table indicating what interface the neighbor or child is bound to.

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

Referenced by NeighborTableEntry(), and GetMacInterfaceIndex().

◆ m_macUcstBytesRx

uint32_t ns3::zigbee::NeighborTableEntry::m_macUcstBytesRx

private

The number of bytes received via MAC unicasts from this neighbor (Optional field).

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

Referenced by GetMacUcstBytesRx(), and SetMacUcstBytesRx().

◆ m_macUcstBytesTx

uint32_t ns3::zigbee::NeighborTableEntry::m_macUcstBytesTx

private

The number of bytes transmitted via MAC unicast to the neighbor (Optional field).

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

Referenced by GetMacUcstBytesTx(), and SetMacUcstBytesTx().

◆ m_nwkAddr

Mac16Address ns3::zigbee::NeighborTableEntry::m_nwkAddr

private

The 16 bit network address of the neighboring device.

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

Referenced by NeighborTableEntry(), GetNwkAddr(), Print(), and SetNwkAddr().

◆ m_outgoingCost

uint8_t ns3::zigbee::NeighborTableEntry::m_outgoingCost

private

The cost of the outgoing link as measured by the neighbor.

A value of 0 indicates no outgoing cost available.

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

Referenced by NeighborTableEntry(), GetOutgoingCost(), Print(), and SetOutgoingCost().

◆ m_potentialParent

bool ns3::zigbee::NeighborTableEntry::m_potentialParent {true}

private

An indication of whether the device has been ruled out as a potential parent.

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

Referenced by IsPotentialParent(), Print(), and SetPotentialParent().

◆ m_relationship

Relationship ns3::zigbee::NeighborTableEntry::m_relationship

private

Relationship between the neighbor and the current device.

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

Referenced by NeighborTableEntry(), GetRelationship(), Print(), and SetRelationship().

◆ m_rxOnWhenIdle

bool ns3::zigbee::NeighborTableEntry::m_rxOnWhenIdle

private

Indicates if the neighbor receiver is enabled during idle periods.

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

Referenced by NeighborTableEntry(), IsRxOnWhenIdle(), and SetRxOnWhenIdle().

◆ m_timeoutCounter

Time ns3::zigbee::NeighborTableEntry::m_timeoutCounter

private

Indicates the current time remaining in seconds, for the end device.

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

Referenced by NeighborTableEntry(), GetTimeoutCounter(), and SetTimeoutCounter().

◆ m_txFailure

uint8_t ns3::zigbee::NeighborTableEntry::m_txFailure

private

A value indicating if previous transmissions to the device were successful or not.

Higher values indicate more failures.

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

Referenced by NeighborTableEntry(), GetTxFailure(), Print(), and SetTxFailure().

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

◆ NeighborTableEntry() [1/2]

◆ ~NeighborTableEntry()

◆ NeighborTableEntry() [2/2]

Member Function Documentation

◆ GetAge()

◆ GetBeaconOrder()

◆ GetBeaconTxTimeOffset()

◆ GetDepth()

◆ GetDeviceType()

◆ GetDevTimeout()

◆ GetEndDevConfig()

◆ GetExtAddr()

◆ GetExtPanId()

◆ GetIncBeaconTimestamp()

◆ GetLogicalCh()

◆ GetLqi()

◆ GetMacInterfaceIndex()

◆ GetMacUcstBytesRx()

◆ GetMacUcstBytesTx()

◆ GetNwkAddr()

◆ GetOutgoingCost()

◆ GetRelationship()

◆ GetTimeoutCounter()

◆ GetTxFailure()

◆ IsPotentialParent()

◆ IsRxOnWhenIdle()

◆ Print()

◆ SetAge()

◆ SetBeaconOrder()

◆ SetBeaconTxTimeOffset()

◆ SetDepth()

◆ SetDeviceType()

◆ SetDevTimeout()

◆ SetEndDevConfig()

◆ SetExtPanId()

◆ SetIncBeaconTimestamp()

◆ SetLogicalCh()

◆ SetLqi()

◆ SetMacInterfaceIndex()

◆ SetMacUcstBytesRx()

◆ SetMacUcstBytesTx()

◆ SetNwkAddr()

◆ SetOutgoingCost()

◆ SetPotentialParent()

◆ SetRelationship()

◆ SetRxOnWhenIdle()

◆ SetTimeoutCounter()

◆ SetTxFailure()

Member Data Documentation

◆ m_age

◆ m_beaconTxTimeOffset

◆ m_bo

◆ m_depth

◆ m_deviceType

◆ m_devTimeout

◆ m_endDevConfig

◆ m_extAddr

◆ m_extPanId

◆ m_incBeaconTimestamp

◆ m_keepaliveRx

◆ m_logicalCh

◆ m_lqi

◆ m_macInterfaceIndex

◆ m_macUcstBytesRx

◆ m_macUcstBytesTx

◆ m_nwkAddr

◆ m_outgoingCost

◆ m_potentialParent

◆ m_relationship

◆ m_rxOnWhenIdle

◆ m_timeoutCounter

◆ m_txFailure