Routing table entry Zigbee Specification r22.1.0, Table 3-66. More...

#include "zigbee-nwk-tables.h"

Inheritance diagram for ns3::zigbee::RoutingTableEntry:

Collaboration diagram for ns3::zigbee::RoutingTableEntry:

Public Member Functions
	RoutingTableEntry ()

	RoutingTableEntry (Mac16Address dst, RouteStatus status, bool noRouteCache, bool manyToOne, bool routeRecordReq, bool groupId, Mac16Address nextHopAddr)
	The constructor the routing table entry.

	~RoutingTableEntry ()

Mac16Address	GetDestination () const
	Get the entry destination nwkAddress(MAC 16-bit address)

Time	GetLifeTime () const
	Get the value of the entry lifetime.

Mac16Address	GetNextHopAddr () const
	Get the value of the next hop address.

RouteStatus	GetStatus () const
	Get the status of the routing table entry.

bool	IsGroupIdPresent () const
	Indicates if the Group Id flag is active.

bool	IsManyToOne () const
	Indicates if the Many-to-One flag is active.

bool	IsNoRouteCache () const
	Indicates if the No Route Cache flag is active.

bool	IsRouteRecordReq () const
	Indicate if the route record request is active.

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

void	SetDestination (Mac16Address dst)
	Set the entry destination nwkAddress (MAC 16-bit address)

void	SetLifeTime (Time lt)
	Set the lifetime of the entry.

void	SetNextHopAddr (Mac16Address nextHopAddr)
	Set the value of the next hop address.

void	SetStatus (RouteStatus status)
	Set the status of the routing table entry.

Public Member Functions inherited from ns3::SimpleRefCount< RoutingTableEntry >
	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
Mac16Address	m_destination
	The 16 bit network address or group id of this route.

bool	m_groupId {false}
	A flag indicating that the destination address is a group id.

Time	m_lifeTime
	Indicates the lifetime of the entry.

bool	m_manyToOne {false}
	A flag indicating that the destination is a concentrator that issued a many-to-one route request.

Mac16Address	m_nextHopAddr
	The 16 bit network address of the next hop on the way to the destination.

bool	m_noRouteCache {true}
	A flag indicating that the destination indicated by this address does not store source routes.

bool	m_routeRecordReq {false}
	A flag indicating that the route record command frame should be sent to the destination prior to the next data packet.

RouteStatus	m_status
	The status of the route.

Detailed Description

Routing table entry Zigbee Specification r22.1.0, Table 3-66.

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

Constructor & Destructor Documentation

◆ RoutingTableEntry() [1/2]

ns3::zigbee::RoutingTableEntry::RoutingTableEntry	(	Mac16Address	dst,
		RouteStatus	status,
		bool	noRouteCache,
		bool	manyToOne,
		bool	routeRecordReq,
		bool	groupId,
		Mac16Address	nextHopAddr )

The constructor the routing table entry.

Parameters

dst	The destination nwkAddress (MAC 16-bit Address).
status	The status of the current entry.
noRouteCache	The value of the route cache flag.
manyToOne	The value of the manyToOne flag.
routeRecordReq	The value of the Route record required flag.
groupId	The value of the group id flag.
nextHopAddr	The value of the 16 bit next hop address.

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

References m_destination, m_groupId, m_manyToOne, m_nextHopAddr, m_noRouteCache, m_routeRecordReq, and m_status.

◆ RoutingTableEntry() [2/2]

ns3::zigbee::RoutingTableEntry::RoutingTableEntry ( )

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

◆ ~RoutingTableEntry()

ns3::zigbee::RoutingTableEntry::~RoutingTableEntry ( )

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

Member Function Documentation

◆ GetDestination()

Mac16Address ns3::zigbee::RoutingTableEntry::GetDestination ( ) const

Get the entry destination nwkAddress(MAC 16-bit address)

Returns: The value of the nwkAddress stored in this entry.

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

References m_destination.

◆ GetLifeTime()

Time ns3::zigbee::RoutingTableEntry::GetLifeTime ( ) const

Get the value of the entry lifetime.

Returns: the lifetime

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

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

Here is the call graph for this function:

◆ GetNextHopAddr()

Mac16Address ns3::zigbee::RoutingTableEntry::GetNextHopAddr ( ) const

Get the value of the next hop address.

Returns: Mac16Address The 16 bit next hop address.

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

References m_nextHopAddr.

◆ GetStatus()

RouteStatus ns3::zigbee::RoutingTableEntry::GetStatus ( ) const

Get the status of the routing table entry.

Returns: The status of the routing table entry.

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

References m_status.

◆ IsGroupIdPresent()

bool ns3::zigbee::RoutingTableEntry::IsGroupIdPresent ( ) const

Indicates if the Group Id flag is active.

Returns: The value of the Group id flag.

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

References m_groupId.

◆ IsManyToOne()

bool ns3::zigbee::RoutingTableEntry::IsManyToOne ( ) const

Indicates if the Many-to-One flag is active.

Returns: The value of the Many-to-one flag.

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

References m_manyToOne.

◆ IsNoRouteCache()

bool ns3::zigbee::RoutingTableEntry::IsNoRouteCache ( ) const

Indicates if the No Route Cache flag is active.

Returns: The value of the no route cache flag.

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

References m_noRouteCache.

◆ IsRouteRecordReq()

bool ns3::zigbee::RoutingTableEntry::IsRouteRecordReq ( ) const

Indicate if the route record request is active.

Returns: The value of the route record request flag.

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

References m_routeRecordReq.

◆ Print()

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

Print the values of the routing table entry.

Parameters

stream The stream object used to print.

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

References m_destination, m_groupId, m_manyToOne, m_nextHopAddr, m_noRouteCache, m_routeRecordReq, m_status, ns3::zigbee::ROUTE_ACTIVE, ns3::zigbee::ROUTE_DISCOVER_FAILED, ns3::zigbee::ROUTE_DISCOVERY_UNDERWAY, ns3::zigbee::ROUTE_INACTIVE, and ns3::zigbee::ROUTE_VALIDATION_UNDERWAY.

◆ SetDestination()

void ns3::zigbee::RoutingTableEntry::SetDestination ( Mac16Address dst )

Set the entry destination nwkAddress (MAC 16-bit address)

Parameters

dst	The value of the destination nwkAddress

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

References m_destination.

◆ SetLifeTime()

void ns3::zigbee::RoutingTableEntry::SetLifeTime ( Time lt )

Set the lifetime of the entry.

Parameters

lt	The time used in the entry lifetime

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

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

Here is the call graph for this function:

◆ SetNextHopAddr()

void ns3::zigbee::RoutingTableEntry::SetNextHopAddr ( Mac16Address nextHopAddr )

Set the value of the next hop address.

Parameters

nextHopAddr The next hop 16-bit nwkAddress

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

References m_nextHopAddr.

◆ SetStatus()

void ns3::zigbee::RoutingTableEntry::SetStatus ( RouteStatus status )

Set the status of the routing table entry.

Parameters

status the status of the routing table entry.

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

References m_status.

Member Data Documentation

◆ m_destination

Mac16Address ns3::zigbee::RoutingTableEntry::m_destination

private

The 16 bit network address or group id of this route.

If the dst device is a router, coordinator or end device, and nwkAddrAlloc has a value of STOCHASTIC_ALLOC this field shall contain the actual 16 bit addr of that device. If the dst device is an end device and nwkAddrAlloc has a value of DISTRIBUTED_ALLOC, this field shall contain the 16 bit nwk address of the device's parent.

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

Referenced by RoutingTableEntry(), GetDestination(), Print(), and SetDestination().

◆ m_groupId

bool ns3::zigbee::RoutingTableEntry::m_groupId {false}

private

A flag indicating that the destination address is a group id.

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

Referenced by RoutingTableEntry(), IsGroupIdPresent(), and Print().

◆ m_lifeTime

Time ns3::zigbee::RoutingTableEntry::m_lifeTime

private

Indicates the lifetime of the entry.

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

Referenced by GetLifeTime(), and SetLifeTime().

◆ m_manyToOne

bool ns3::zigbee::RoutingTableEntry::m_manyToOne {false}

private

A flag indicating that the destination is a concentrator that issued a many-to-one route request.

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

Referenced by RoutingTableEntry(), IsManyToOne(), and Print().

◆ m_nextHopAddr

Mac16Address ns3::zigbee::RoutingTableEntry::m_nextHopAddr

private

The 16 bit network address of the next hop on the way to the destination.

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

Referenced by RoutingTableEntry(), GetNextHopAddr(), Print(), and SetNextHopAddr().

◆ m_noRouteCache

bool ns3::zigbee::RoutingTableEntry::m_noRouteCache {true}

private

A flag indicating that the destination indicated by this address does not store source routes.

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

Referenced by RoutingTableEntry(), IsNoRouteCache(), and Print().

◆ m_routeRecordReq

bool ns3::zigbee::RoutingTableEntry::m_routeRecordReq {false}

private

A flag indicating that the route record command frame should be sent to the destination prior to the next data packet.

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

Referenced by RoutingTableEntry(), IsRouteRecordReq(), and Print().

◆ m_status

RouteStatus ns3::zigbee::RoutingTableEntry::m_status

private

The status of the route.

Also see Zigbee specification r22.1.0, Table 3-67

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

Referenced by RoutingTableEntry(), GetStatus(), Print(), and SetStatus().

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

◆ RoutingTableEntry() [1/2]

◆ RoutingTableEntry() [2/2]

◆ ~RoutingTableEntry()

Member Function Documentation

◆ GetDestination()

◆ GetLifeTime()

◆ GetNextHopAddr()

◆ GetStatus()

◆ IsGroupIdPresent()

◆ IsManyToOne()

◆ IsNoRouteCache()

◆ IsRouteRecordReq()

◆ Print()

◆ SetDestination()

◆ SetLifeTime()

◆ SetNextHopAddr()

◆ SetStatus()

Member Data Documentation

◆ m_destination

◆ m_groupId

◆ m_lifeTime

◆ m_manyToOne

◆ m_nextHopAddr

◆ m_noRouteCache

◆ m_routeRecordReq

◆ m_status