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

This class generates sequential LoraDeviceAddress instances. More...

#include "lora-device-address-generator.h"

+ Inheritance diagram for ns3::lorawan::LoraDeviceAddressGenerator:
+ Collaboration diagram for ns3::lorawan::LoraDeviceAddressGenerator:

Public Member Functions

 LoraDeviceAddressGenerator (const uint8_t nwkId=0, const uint32_t nwkAddr=0)
 Initialise the base NwkID and the first NwkAddr to be used by the generator.
 
LoraDeviceAddress GetNextAddress ()
 Get the LoraDeviceAddress that will be allocated upon a call to NextAddress.
 
LoraDeviceAddress NextAddress ()
 Allocate the next LoraDeviceAddress.
 
LoraDeviceAddress NextNetwork ()
 Get the first address from the next network.
 
- 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 override
 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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) 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.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
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 ()
 Register this type.
 
- 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.
 

Private Attributes

NwkAddr m_currentNwkAddr
 The current Network Address value.
 
NwkID m_currentNwkId
 The current Network Id value.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
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.
 

Detailed Description

This class generates sequential LoraDeviceAddress instances.

Definition at line 37 of file lora-device-address-generator.h.

Constructor & Destructor Documentation

◆ LoraDeviceAddressGenerator()

ns3::lorawan::LoraDeviceAddressGenerator::LoraDeviceAddressGenerator ( const uint8_t  nwkId = 0,
const uint32_t  nwkAddr = 0 
)

Initialise the base NwkID and the first NwkAddr to be used by the generator.

The first call to NextAddress() or GetAddress() will return these values.

Parameters
nwkIdThe first network id.
nwkAddrThe first address.

Definition at line 41 of file lora-device-address-generator.cc.

References m_currentNwkAddr, m_currentNwkId, NS_LOG_FUNCTION, ns3::lorawan::NwkAddr::Set(), and ns3::lorawan::NwkID::Set().

+ Here is the call graph for this function:

Member Function Documentation

◆ GetNextAddress()

LoraDeviceAddress ns3::lorawan::LoraDeviceAddressGenerator::GetNextAddress ( )

Get the LoraDeviceAddress that will be allocated upon a call to NextAddress.

Does not change the internal state; is just used to peek at the next address that will be allocated upon a call to NextAddress.

Returns
The LoraDeviceAddress.

Definition at line 72 of file lora-device-address-generator.cc.

References ns3::lorawan::NwkID::Get(), ns3::lorawan::NwkAddr::Get(), m_currentNwkAddr, m_currentNwkId, and NS_LOG_FUNCTION_NOARGS.

Referenced by AddressTest::DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::lorawan::LoraDeviceAddressGenerator::GetTypeId ( )
static

Register this type.

Returns
The object TypeId.

Definition at line 32 of file lora-device-address-generator.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ NextAddress()

LoraDeviceAddress ns3::lorawan::LoraDeviceAddressGenerator::NextAddress ( )

Allocate the next LoraDeviceAddress.

This operation is a post-increment, meaning that the first address allocated will be the one that was initially configured.

This keeps the nwkId constant, only incrementing nwkAddr.

Returns
The LoraDeviceAddress address.

Definition at line 61 of file lora-device-address-generator.cc.

References ns3::lorawan::NwkAddr::Get(), m_currentNwkAddr, m_currentNwkId, NS_LOG_FUNCTION_NOARGS, and ns3::lorawan::NwkAddr::Set().

Referenced by AddressTest::DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ NextNetwork()

LoraDeviceAddress ns3::lorawan::LoraDeviceAddressGenerator::NextNetwork ( )

Get the first address from the next network.

This resets the address to the base address that was used for initialization.

Returns
The LoraDeviceAddress address of the next network.

Definition at line 50 of file lora-device-address-generator.cc.

References ns3::lorawan::NwkID::Get(), m_currentNwkAddr, m_currentNwkId, NS_LOG_FUNCTION_NOARGS, ns3::lorawan::NwkAddr::Set(), and ns3::lorawan::NwkID::Set().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_currentNwkAddr

NwkAddr ns3::lorawan::LoraDeviceAddressGenerator::m_currentNwkAddr
private

The current Network Address value.

Definition at line 92 of file lora-device-address-generator.h.

Referenced by LoraDeviceAddressGenerator(), GetNextAddress(), NextAddress(), and NextNetwork().

◆ m_currentNwkId

NwkID ns3::lorawan::LoraDeviceAddressGenerator::m_currentNwkId
private

The current Network Id value.

Definition at line 91 of file lora-device-address-generator.h.

Referenced by LoraDeviceAddressGenerator(), GetNextAddress(), NextAddress(), and NextNetwork().


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