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

Implementation of the LinkAdrReq LoRaWAN MAC command. More...

#include "mac-command.h"

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

Public Member Functions

 LinkAdrReq ()
 
 LinkAdrReq (uint8_t dataRate, uint8_t txPower, uint16_t channelMask, uint8_t chMaskCntl, uint8_t nbRep)
 Constructor with given fields.
 
uint8_t Deserialize (Buffer::Iterator &start) override
 Deserialize the buffer into a MAC command.
 
uint8_t GetDataRate ()
 Return the data rate prescribed by this MAC command.
 
std::list< int > GetEnabledChannelsList ()
 Get the list of enabled channels.
 
int GetRepetitions ()
 Get the number of repetitions prescribed by this MAC command.
 
uint8_t GetTxPower ()
 Get the transmission power prescribed by this MAC command.
 
void Print (std::ostream &os) const override
 Print the contents of this MAC command in human-readable format.
 
void Serialize (Buffer::Iterator &start) const override
 Serialize the contents of this MAC command into a buffer, according to the LoRaWAN standard.
 
- Public Member Functions inherited from ns3::lorawan::MacCommand
 MacCommand ()
 Default constructor.
 
 ~MacCommand () override
 Destructor.
 
virtual enum MacCommandType GetCommandType () const
 Get the commandType of this MAC command.
 
virtual uint8_t GetSerializedSize () const
 Get serialized length of this MAC command.
 
- 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, 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.
 

Private Attributes

uint16_t m_channelMask
 The ChMask field.
 
uint8_t m_chMaskCntl
 The ChMaskCntl field.
 
uint8_t m_dataRate
 The DataRate field, a serializable parameter for setting the spreading factor and bandwidth of end devices.
 
uint8_t m_nbRep
 The NbTrans field.
 
uint8_t m_txPower
 The TXPower field, a serializable parameter for setting the transmission power of end devices.
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::lorawan::MacCommand
static uint8_t GetCIDFromMacCommand (enum MacCommandType commandType)
 Get the CID that corresponds to a type of MAC command.
 
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.
 
- 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.
 
- Protected Attributes inherited from ns3::lorawan::MacCommand
enum MacCommandType m_commandType
 The type of this command.
 
uint8_t m_serializedSize
 This MAC command's serialized size.
 

Detailed Description

Implementation of the LinkAdrReq LoRaWAN MAC command.

With this command, the network server can request a device to change its data rate, transmission power and the channel it uses for uplink transmissions.

Definition at line 207 of file mac-command.h.

Constructor & Destructor Documentation

◆ LinkAdrReq() [1/2]

ns3::lorawan::LinkAdrReq::LinkAdrReq ( )

◆ LinkAdrReq() [2/2]

ns3::lorawan::LinkAdrReq::LinkAdrReq ( uint8_t dataRate,
uint8_t txPower,
uint16_t channelMask,
uint8_t chMaskCntl,
uint8_t nbRep )

Constructor with given fields.

The parameters of this constructor are serializable fields of the MAC command specified by the LoRaWAN protocol. They represent MAC and PHY layer configurations to be applied by the receiving end device. See, [LoRaWAN® L2 1.0.4 Specification (TS001-1.0.4)] and [LoRaWAN® Regional Parameters RP002-1.0.4] for more details on how the fields are used and which physical values they stand for.

Parameters
dataRateThe DataRate field to set.
txPowerThe TXPower field to set.
channelMaskThe ChMask field to set.
chMaskCntlThe ChMaskCntl field to set.
nbRepThe NbTrans field to set.

Definition at line 265 of file mac-command.cc.

References ns3::lorawan::LINK_ADR_REQ, ns3::lorawan::MacCommand::m_commandType, ns3::lorawan::MacCommand::m_serializedSize, and NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

uint8_t ns3::lorawan::LinkAdrReq::Deserialize ( Buffer::Iterator & start)
overridevirtual

Deserialize the buffer into a MAC command.

Parameters
startA pointer to the buffer that contains the serialized command.
Returns
The number of bytes that were consumed.

Implements ns3::lorawan::MacCommand.

Definition at line 295 of file mac-command.cc.

References m_channelMask, m_chMaskCntl, m_dataRate, m_nbRep, ns3::lorawan::MacCommand::m_serializedSize, m_txPower, and NS_LOG_FUNCTION_NOARGS.

◆ GetDataRate()

uint8_t ns3::lorawan::LinkAdrReq::GetDataRate ( )

Return the data rate prescribed by this MAC command.

Returns
An unsigned 8-bit integer containing the data rate.

Definition at line 326 of file mac-command.cc.

References m_dataRate, and NS_LOG_FUNCTION.

◆ GetEnabledChannelsList()

std::list< int > ns3::lorawan::LinkAdrReq::GetEnabledChannelsList ( )

Get the list of enabled channels.

This method takes the 16-bit channel mask and translates it to a list of integers that can be more easily parsed.

Returns
The list of enabled channels.

Definition at line 342 of file mac-command.cc.

References m_channelMask, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

◆ GetRepetitions()

int ns3::lorawan::LinkAdrReq::GetRepetitions ( )

Get the number of repetitions prescribed by this MAC command.

Returns
The number of repetitions.

Definition at line 360 of file mac-command.cc.

References m_nbRep, and NS_LOG_FUNCTION.

◆ GetTxPower()

uint8_t ns3::lorawan::LinkAdrReq::GetTxPower ( )

Get the transmission power prescribed by this MAC command.

The MAC layer is expected to translate this value to a certain power in dBm when communicating it to the PHY, and the translation will vary based on the region of the device.

Returns
The TX power, encoded as an unsigned 8-bit integer.

Definition at line 334 of file mac-command.cc.

References m_txPower, and NS_LOG_FUNCTION.

◆ Print()

void ns3::lorawan::LinkAdrReq::Print ( std::ostream & os) const
overridevirtual

Print the contents of this MAC command in human-readable format.

Parameters
osThe std::ostream instance on which to print the MAC command.

Implements ns3::lorawan::MacCommand.

Definition at line 313 of file mac-command.cc.

References m_channelMask, m_chMaskCntl, m_dataRate, m_nbRep, m_txPower, and NS_LOG_FUNCTION_NOARGS.

◆ Serialize()

void ns3::lorawan::LinkAdrReq::Serialize ( Buffer::Iterator & start) const
overridevirtual

Serialize the contents of this MAC command into a buffer, according to the LoRaWAN standard.

Parameters
startA pointer to the buffer into which to serialize the command.

Implements ns3::lorawan::MacCommand.

Definition at line 283 of file mac-command.cc.

References ns3::lorawan::MacCommand::GetCIDFromMacCommand(), m_channelMask, m_chMaskCntl, ns3::lorawan::MacCommand::m_commandType, m_dataRate, m_nbRep, m_txPower, and NS_LOG_FUNCTION_NOARGS.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_channelMask

uint16_t ns3::lorawan::LinkAdrReq::m_channelMask
private

The ChMask field.

Definition at line 274 of file mac-command.h.

Referenced by Deserialize(), GetEnabledChannelsList(), Print(), and Serialize().

◆ m_chMaskCntl

uint8_t ns3::lorawan::LinkAdrReq::m_chMaskCntl
private

The ChMaskCntl field.

Definition at line 275 of file mac-command.h.

Referenced by Deserialize(), Print(), and Serialize().

◆ m_dataRate

uint8_t ns3::lorawan::LinkAdrReq::m_dataRate
private

The DataRate field, a serializable parameter for setting the spreading factor and bandwidth of end devices.

Definition at line 270 of file mac-command.h.

Referenced by Deserialize(), GetDataRate(), Print(), and Serialize().

◆ m_nbRep

uint8_t ns3::lorawan::LinkAdrReq::m_nbRep
private

The NbTrans field.

Definition at line 276 of file mac-command.h.

Referenced by Deserialize(), GetRepetitions(), Print(), and Serialize().

◆ m_txPower

uint8_t ns3::lorawan::LinkAdrReq::m_txPower
private

The TXPower field, a serializable parameter for setting the transmission power of end devices.

Definition at line 272 of file mac-command.h.

Referenced by Deserialize(), GetTxPower(), Print(), and Serialize().


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