A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ns3::zigbee::ZigbeeStack Class Reference
ZIGBEE models

Zigbee protocol stack to device interface. More...

#include "zigbee-stack.h"

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

Public Member Functions

 ZigbeeStack ()
 Default constructor.
 
 ~ZigbeeStack () override
 
Ptr< ZigbeeAps > GetAps () const
 Get the APS layer used by this ZigbeeStack.
 
Ptr< Channel > GetChannel () const
 Get the Channel object of the underlying LrWpanNetDevice.
 
Ptr< NetDevice > GetNetDevice () const
 Returns a smart pointer to the underlying NetDevice.
 
Ptr< Node > GetNode () const
 Get the node currently using this ZigbeeStack.
 
Ptr< ZigbeeNwk > GetNwk () const
 Get the NWK layer used by this ZigbeeStack.
 
void SetAps (Ptr< ZigbeeAps > aps)
 Set the APS layer used by this ZigbeeStack.
 
void SetNetDevice (Ptr< NetDevice > netDevice)
 Setup Zigbee to be the next set of higher layers for the specified NetDevice.
 
void SetNwk (Ptr< ZigbeeNwk > nwk)
 Set the NWK layer used by this ZigbeeStack.
 
void SetOnlyNwkLayer ()
 Inticates to the Zigbee stack that only the NWK layer should be present.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const final
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< Object > GetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 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.
 
- 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::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Protected Member Functions

void DoDispose () override
 Dispose of the Objects used by the ZigbeeStack.
 
void DoInitialize () override
 Initialize of the Objects used by the ZigbeeStack.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- 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.
 

Private Attributes

Ptr< ZigbeeAps > m_aps
 The Zigbee Application Support Sub-layer.
 
Ptr< lrwpan::LrWpanMacBase > m_mac
 The underlying LrWpan MAC connected to this Zigbee Stack.
 
Ptr< NetDevice > m_netDevice
 Smart pointer to the underlying NetDevice.
 
Ptr< Node > m_node
 The node associated with this NetDevice.
 
Ptr< ZigbeeNwk > m_nwk
 The Zigbee Network layer.
 
bool m_nwkOnly
 Indicates that only the NWK layer is present in the Zigbee stack.
 

Additional Inherited Members

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

Detailed Description

Zigbee protocol stack to device interface.

Introspection did not find any typical Config paths.

This class is an encapsulating class representing the protocol stack as described by the Zigbee Specification. In the current implementation only the Zigbee network layer (NWK) is included. However, this class is meant be later be extended to include other layer and sublayers part of the Zigbee Specification. The implementation is analogous to a NetDevice which encapsulates PHY and MAC layers and provide the necessary hooks. Zigbee Stack is meant to encapsulate NWK, APS, ZLC layers (and others if applicable).


No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Zigbee

Size of this type is 104 bytes (on a 64-bit architecture).

Definition at line 47 of file zigbee-stack.h.

Constructor & Destructor Documentation

◆ ZigbeeStack()

ns3::zigbee::ZigbeeStack::ZigbeeStack ( )

Default constructor.

Definition at line 38 of file zigbee-stack.cc.

References ns3::CreateObject(), m_aps, m_nwk, m_nwkOnly, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ ~ZigbeeStack()

ns3::zigbee::ZigbeeStack::~ZigbeeStack ( )
override

Definition at line 48 of file zigbee-stack.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::zigbee::ZigbeeStack::DoDispose ( )
overrideprotectedvirtual

Dispose of the Objects used by the ZigbeeStack.

Reimplemented from ns3::Object.

Definition at line 54 of file zigbee-stack.cc.

References ns3::Object::DoDispose(), m_aps, m_mac, m_netDevice, m_node, m_nwk, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoInitialize()

void ns3::zigbee::ZigbeeStack::DoInitialize ( )
overrideprotectedvirtual

Initialize of the Objects used by the ZigbeeStack.

Reimplemented from ns3::Object.

Definition at line 67 of file zigbee-stack.cc.

References ns3::Object::AggregateObject(), ns3::Object::DoInitialize(), m_aps, m_mac, m_netDevice, m_nwk, m_nwkOnly, ns3::MakeCallback(), ns3::zigbee::ZigbeeNwk::McpsDataConfirm(), ns3::zigbee::ZigbeeNwk::McpsDataIndication(), ns3::zigbee::ZigbeeNwk::MlmeAssociateConfirm(), ns3::zigbee::ZigbeeNwk::MlmeAssociateIndication(), ns3::zigbee::ZigbeeNwk::MlmeBeaconNotifyIndication(), ns3::zigbee::ZigbeeNwk::MlmeCommStatusIndication(), ns3::zigbee::ZigbeeNwk::MlmeGetConfirm(), ns3::zigbee::ZigbeeNwk::MlmeOrphanIndication(), ns3::zigbee::ZigbeeNwk::MlmeScanConfirm(), ns3::zigbee::ZigbeeNwk::MlmeSetConfirm(), ns3::zigbee::ZigbeeNwk::MlmeStartConfirm(), ns3::zigbee::ZigbeeAps::NldeDataConfirm(), ns3::zigbee::ZigbeeAps::NldeDataIndication(), NS_ABORT_MSG_UNLESS, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetAps()

Ptr< zigbee::ZigbeeAps > ns3::zigbee::ZigbeeStack::GetAps ( ) const

Get the APS layer used by this ZigbeeStack.

Returns
the APS object

Definition at line 169 of file zigbee-stack.cc.

References m_aps.

◆ GetChannel()

Ptr< Channel > ns3::zigbee::ZigbeeStack::GetChannel ( ) const

Get the Channel object of the underlying LrWpanNetDevice.

Returns
The LrWpanNetDevice Channel Object

Definition at line 123 of file zigbee-stack.cc.

References m_netDevice.

◆ GetNetDevice()

Ptr< NetDevice > ns3::zigbee::ZigbeeStack::GetNetDevice ( ) const

Returns a smart pointer to the underlying NetDevice.

Returns
A smart pointer to the underlying NetDevice.

Definition at line 135 of file zigbee-stack.cc.

References m_netDevice.

◆ GetNode()

Ptr< Node > ns3::zigbee::ZigbeeStack::GetNode ( ) const

Get the node currently using this ZigbeeStack.

Returns
The reference to the node object using this ZigbeeStack.

Definition at line 129 of file zigbee-stack.cc.

References m_node.

◆ GetNwk()

Ptr< zigbee::ZigbeeNwk > ns3::zigbee::ZigbeeStack::GetNwk ( ) const

Get the NWK layer used by this ZigbeeStack.

Returns
the NWK object

Definition at line 155 of file zigbee-stack.cc.

References m_nwk.

◆ GetTypeId()

TypeId ns3::zigbee::ZigbeeStack::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 29 of file zigbee-stack.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetAps()

void ns3::zigbee::ZigbeeStack::SetAps ( Ptr< ZigbeeAps > aps)

Set the APS layer used by this ZigbeeStack.

Parameters
apsThe APS layer object

Definition at line 175 of file zigbee-stack.cc.

References ns3::Object::IsInitialized(), m_aps, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SetNetDevice()

void ns3::zigbee::ZigbeeStack::SetNetDevice ( Ptr< NetDevice > netDevice)

Setup Zigbee to be the next set of higher layers for the specified NetDevice.

All the packets incoming and outgoing from the NetDevice will be processed by ZigbeeStack.

Parameters
netDeviceA smart pointer to the NetDevice used by Zigbee.

Definition at line 141 of file zigbee-stack.cc.

References m_netDevice, m_node, and NS_LOG_FUNCTION.

◆ SetNwk()

void ns3::zigbee::ZigbeeStack::SetNwk ( Ptr< ZigbeeNwk > nwk)

Set the NWK layer used by this ZigbeeStack.

Parameters
nwkThe NWK layer object

Definition at line 161 of file zigbee-stack.cc.

References ns3::Object::IsInitialized(), m_nwk, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SetOnlyNwkLayer()

void ns3::zigbee::ZigbeeStack::SetOnlyNwkLayer ( )

Inticates to the Zigbee stack that only the NWK layer should be present.

Definition at line 149 of file zigbee-stack.cc.

References m_nwkOnly.

Member Data Documentation

◆ m_aps

Ptr<ZigbeeAps> ns3::zigbee::ZigbeeStack::m_aps
private

The Zigbee Application Support Sub-layer.

Definition at line 138 of file zigbee-stack.h.

Referenced by ZigbeeStack(), DoDispose(), DoInitialize(), GetAps(), and SetAps().

◆ m_mac

Ptr<lrwpan::LrWpanMacBase> ns3::zigbee::ZigbeeStack::m_mac
private

The underlying LrWpan MAC connected to this Zigbee Stack.

Definition at line 136 of file zigbee-stack.h.

Referenced by DoDispose(), and DoInitialize().

◆ m_netDevice

Ptr<NetDevice> ns3::zigbee::ZigbeeStack::m_netDevice
private

Smart pointer to the underlying NetDevice.

Definition at line 140 of file zigbee-stack.h.

Referenced by DoDispose(), DoInitialize(), GetChannel(), GetNetDevice(), and SetNetDevice().

◆ m_node

Ptr<Node> ns3::zigbee::ZigbeeStack::m_node
private

The node associated with this NetDevice.

Definition at line 139 of file zigbee-stack.h.

Referenced by DoDispose(), GetNode(), and SetNetDevice().

◆ m_nwk

Ptr<ZigbeeNwk> ns3::zigbee::ZigbeeStack::m_nwk
private

The Zigbee Network layer.

Definition at line 137 of file zigbee-stack.h.

Referenced by ZigbeeStack(), DoDispose(), DoInitialize(), GetNwk(), and SetNwk().

◆ m_nwkOnly

bool ns3::zigbee::ZigbeeStack::m_nwkOnly
private

Indicates that only the NWK layer is present in the Zigbee stack.

Definition at line 141 of file zigbee-stack.h.

Referenced by ZigbeeStack(), DoInitialize(), and SetOnlyNwkLayer().

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