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

Binding Table entry: Source portion of the table. More...

#include "zigbee-aps-tables.h"

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

Public Member Functions

 SrcBindingEntry ()
 The default constructor of the source binding entry.
 
 SrcBindingEntry (Mac64Address address, uint8_t endPoint, uint16_t clusterId)
 Constructor of the source binding entry.
 
 ~SrcBindingEntry ()
 
uint16_t GetClusterId () const
 Get the cluster ID from the source binding entry.
 
Mac64Address GetSrcAddress () const
 Get the IEEE address from the source binding entry.
 
uint8_t GetSrcEndPoint () const
 Get the source endpoint from the source binding entry.
 
void SetClusterId (uint16_t clusterId)
 Set the cluster ID of the source binding entry.
 
void SetSrcAddress (Mac64Address address)
 Set the source IEEE address to the entry.
 
void SetSrcEndPoint (uint8_t endPoint)
 Set the source endpoint of the source binding entry.
 
- Public Member Functions inherited from ns3::SimpleRefCount< SrcBindingEntry >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 

Private Attributes

uint16_t m_clusterId {0}
 The cluster ID in the source entry.
 
Mac64Address m_srcAddr
 The source IEEE address in the source entry.
 
uint8_t m_srcEndPoint {0}
 The source endpoint in the source entry.
 

Detailed Description

Binding Table entry: Source portion of the table.

As described in Zigbee Specification r22.1.0, Table 2-134

Definition at line 61 of file zigbee-aps-tables.h.

Constructor & Destructor Documentation

◆ SrcBindingEntry() [1/2]

ns3::zigbee::SrcBindingEntry::SrcBindingEntry ( )

The default constructor of the source binding entry.

Definition at line 30 of file zigbee-aps-tables.cc.

◆ SrcBindingEntry() [2/2]

ns3::zigbee::SrcBindingEntry::SrcBindingEntry ( Mac64Address address,
uint8_t endPoint,
uint16_t clusterId )

Constructor of the source binding entry.

Parameters
addressThe IEEE address to register, (typically the IEEE address of the source device).
endPointThe source endpoint to register to the entry.
clusterIdThe cluster ID to register to the entry.

Definition at line 34 of file zigbee-aps-tables.cc.

References m_clusterId, m_srcAddr, and m_srcEndPoint.

◆ ~SrcBindingEntry()

ns3::zigbee::SrcBindingEntry::~SrcBindingEntry ( )

Definition at line 41 of file zigbee-aps-tables.cc.

Member Function Documentation

◆ GetClusterId()

uint16_t ns3::zigbee::SrcBindingEntry::GetClusterId ( ) const

Get the cluster ID from the source binding entry.

Returns
The cluster ID.

Definition at line 76 of file zigbee-aps-tables.cc.

References m_clusterId.

◆ GetSrcAddress()

Mac64Address ns3::zigbee::SrcBindingEntry::GetSrcAddress ( ) const

Get the IEEE address from the source binding entry.

Returns
The IEEE address in the source binding entry.

Definition at line 64 of file zigbee-aps-tables.cc.

References m_srcAddr.

◆ GetSrcEndPoint()

uint8_t ns3::zigbee::SrcBindingEntry::GetSrcEndPoint ( ) const

Get the source endpoint from the source binding entry.

Returns
The source endpoint.

Definition at line 70 of file zigbee-aps-tables.cc.

References m_srcEndPoint.

◆ SetClusterId()

void ns3::zigbee::SrcBindingEntry::SetClusterId ( uint16_t clusterId)

Set the cluster ID of the source binding entry.

Parameters
clusterIdThe cluster ID to set in the entry.

Definition at line 58 of file zigbee-aps-tables.cc.

References m_clusterId.

◆ SetSrcAddress()

void ns3::zigbee::SrcBindingEntry::SetSrcAddress ( Mac64Address address)

Set the source IEEE address to the entry.

Parameters
addressThe IEEE address (64-bit address) of the entry

Definition at line 46 of file zigbee-aps-tables.cc.

References m_srcAddr.

◆ SetSrcEndPoint()

void ns3::zigbee::SrcBindingEntry::SetSrcEndPoint ( uint8_t endPoint)

Set the source endpoint of the source binding entry.

Parameters
endPointThe source endpoint to set in the entry.

Definition at line 52 of file zigbee-aps-tables.cc.

References m_srcEndPoint.

Member Data Documentation

◆ m_clusterId

uint16_t ns3::zigbee::SrcBindingEntry::m_clusterId {0}
private

The cluster ID in the source entry.

Definition at line 121 of file zigbee-aps-tables.h.

Referenced by SrcBindingEntry(), GetClusterId(), and SetClusterId().

◆ m_srcAddr

Mac64Address ns3::zigbee::SrcBindingEntry::m_srcAddr
private

The source IEEE address in the source entry.

Definition at line 119 of file zigbee-aps-tables.h.

Referenced by SrcBindingEntry(), GetSrcAddress(), and SetSrcAddress().

◆ m_srcEndPoint

uint8_t ns3::zigbee::SrcBindingEntry::m_srcEndPoint {0}
private

The source endpoint in the source entry.

Definition at line 120 of file zigbee-aps-tables.h.

Referenced by SrcBindingEntry(), GetSrcEndPoint(), and SetSrcEndPoint().


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