Implementation of the LinkAdrReq LoRaWAN MAC command. More...
#include "mac-command.h"
Public Member Functions | |
LinkAdrReq () | |
Default constructor. | |
LinkAdrReq (uint8_t dataRate, uint8_t txPower, uint16_t chMask, uint8_t chMaskCntl, uint8_t nbTrans) | |
Constructor with given fields. | |
uint8_t | Deserialize (Buffer::Iterator &start) override |
Deserialize the buffer into a MAC command. | |
uint16_t | GetChMask () const |
Get the 16 bit mask of enabled channels. | |
uint8_t | GetChMaskCntl () const |
Get the ChMaskCntl field, used as an indicator of the 16-channel bank to apply the ChMask to. | |
uint8_t | GetDataRate () const |
Return the data rate prescribed by this MAC command. | |
uint8_t | GetNbTrans () const |
Get the number of repeated transmissions prescribed by this MAC command. | |
uint8_t | GetTxPower () const |
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. | |
virtual | ~MacCommand () |
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::SimpleRefCount< MacCommand > | |
SimpleRefCount () | |
Default 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 | |
uint16_t | m_chMask |
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_nbTrans |
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. | |
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. |
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 182 of file mac-command.h.
ns3::lorawan::LinkAdrReq::LinkAdrReq | ( | ) |
Default constructor.
Definition at line 196 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.
ns3::lorawan::LinkAdrReq::LinkAdrReq | ( | uint8_t | dataRate, |
uint8_t | txPower, | ||
uint16_t | chMask, | ||
uint8_t | chMaskCntl, | ||
uint8_t | nbTrans ) |
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.
dataRate | The DataRate field to set. |
txPower | The TXPower field to set. |
chMask | The ChMask field to set. |
chMaskCntl | The ChMaskCntl field to set. |
nbTrans | The NbTrans field to set. |
Definition at line 203 of file mac-command.cc.
References ns3::lorawan::LINK_ADR_REQ, m_chMask, m_chMaskCntl, ns3::lorawan::MacCommand::m_commandType, m_dataRate, m_nbTrans, ns3::lorawan::MacCommand::m_serializedSize, m_txPower, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
|
overridevirtual |
Deserialize the buffer into a MAC command.
start | A pointer to the buffer that contains the serialized command. |
Implements ns3::lorawan::MacCommand.
Definition at line 234 of file mac-command.cc.
References m_chMask, m_chMaskCntl, m_dataRate, m_nbTrans, ns3::lorawan::MacCommand::m_serializedSize, m_txPower, and NS_LOG_FUNCTION.
uint16_t ns3::lorawan::LinkAdrReq::GetChMask | ( | ) | const |
Get the 16 bit mask of enabled channels.
Definition at line 276 of file mac-command.cc.
References m_chMask, and NS_LOG_FUNCTION.
uint8_t ns3::lorawan::LinkAdrReq::GetChMaskCntl | ( | ) | const |
Get the ChMaskCntl field, used as an indicator of the 16-channel bank to apply the ChMask to.
The interpretation of this field is region-dependent.
Definition at line 283 of file mac-command.cc.
References m_chMaskCntl, and NS_LOG_FUNCTION.
uint8_t ns3::lorawan::LinkAdrReq::GetDataRate | ( | ) | const |
Return the data rate prescribed by this MAC command.
Definition at line 262 of file mac-command.cc.
References m_dataRate, and NS_LOG_FUNCTION.
uint8_t ns3::lorawan::LinkAdrReq::GetNbTrans | ( | ) | const |
Get the number of repeated transmissions prescribed by this MAC command.
Definition at line 290 of file mac-command.cc.
References m_nbTrans, and NS_LOG_FUNCTION.
uint8_t ns3::lorawan::LinkAdrReq::GetTxPower | ( | ) | const |
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.
Definition at line 269 of file mac-command.cc.
References m_txPower, and NS_LOG_FUNCTION.
|
overridevirtual |
Print the contents of this MAC command in human-readable format.
os | The std::ostream instance on which to print the MAC command. |
Implements ns3::lorawan::MacCommand.
Definition at line 249 of file mac-command.cc.
References m_chMask, m_chMaskCntl, m_dataRate, m_nbTrans, m_txPower, and NS_LOG_FUNCTION.
|
overridevirtual |
Serialize the contents of this MAC command into a buffer, according to the LoRaWAN standard.
start | A pointer to the buffer into which to serialize the command. |
Implements ns3::lorawan::MacCommand.
Definition at line 224 of file mac-command.cc.
References ns3::lorawan::MacCommand::GetCIDFromMacCommand(), m_chMask, m_chMaskCntl, ns3::lorawan::MacCommand::m_commandType, m_dataRate, m_nbTrans, m_txPower, and NS_LOG_FUNCTION.
|
private |
The ChMask field.
Definition at line 258 of file mac-command.h.
Referenced by LinkAdrReq(), Deserialize(), GetChMask(), Print(), and Serialize().
|
private |
The ChMaskCntl field.
Definition at line 259 of file mac-command.h.
Referenced by LinkAdrReq(), Deserialize(), GetChMaskCntl(), Print(), and Serialize().
|
private |
The DataRate field, a serializable parameter for setting the spreading factor and bandwidth of end devices.
Definition at line 254 of file mac-command.h.
Referenced by LinkAdrReq(), Deserialize(), GetDataRate(), Print(), and Serialize().
|
private |
The NbTrans field.
Definition at line 260 of file mac-command.h.
Referenced by LinkAdrReq(), Deserialize(), GetNbTrans(), Print(), and Serialize().
|
private |
The TXPower field, a serializable parameter for setting the transmission power of end devices.
Definition at line 256 of file mac-command.h.
Referenced by LinkAdrReq(), Deserialize(), GetTxPower(), Print(), and Serialize().