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

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

#include "mac-command.h"

Inheritance diagram for ns3::lorawan::LinkCheckAns:
Collaboration diagram for ns3::lorawan::LinkCheckAns:

Public Member Functions

 LinkCheckAns ()
 Default constructor.
 LinkCheckAns (uint8_t margin, uint8_t gwCnt)
 Constructor with given fields.
uint8_t Deserialize (Buffer::Iterator &start) override
 Deserialize the buffer into a MAC command.
uint8_t GetGwCnt () const
 Get the gateway count value.
uint8_t GetMargin () const
 Get the demodulation margin value.
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.
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
void Ref () const
 Increment the reference count.
void Unref () const
 Decrement the reference count.

Private Attributes

uint8_t m_gwCnt
 This MAC command's gateway count value.
uint8_t m_margin
 This MAC command's demodulation margin value.

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.

Detailed Description

Implementation of the LinkCheckAns LoRaWAN MAC command.

This command contains the demodulation margin and the number of receiving gateways of the packet containing the LinkCheckReq command.

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

Constructor & Destructor Documentation

◆ LinkCheckAns() [1/2]

ns3::lorawan::LinkCheckAns::LinkCheckAns ( )

◆ LinkCheckAns() [2/2]

ns3::lorawan::LinkCheckAns::LinkCheckAns ( uint8_t margin,
uint8_t gwCnt )

Constructor with given fields.

Parameters
marginThe demodulation margin to set.
gwCntThe gateway count to set.

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

References ns3::lorawan::LINK_CHECK_ANS, ns3::lorawan::MacCommand::m_commandType, m_gwCnt, m_margin, ns3::lorawan::MacCommand::m_serializedSize, and NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

uint8_t ns3::lorawan::LinkCheckAns::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 158 of file mac-command.cc.

References m_gwCnt, m_margin, ns3::lorawan::MacCommand::m_serializedSize, and NS_LOG_FUNCTION.

◆ GetGwCnt()

uint8_t ns3::lorawan::LinkCheckAns::GetGwCnt ( ) const

Get the gateway count value.

Returns
The gateway count value.

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

References m_gwCnt, and NS_LOG_FUNCTION.

◆ GetMargin()

uint8_t ns3::lorawan::LinkCheckAns::GetMargin ( ) const

Get the demodulation margin value.

Returns
The demodulation margin value.

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

References m_margin, and NS_LOG_FUNCTION.

◆ Print()

void ns3::lorawan::LinkCheckAns::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 168 of file mac-command.cc.

References m_gwCnt, m_margin, and NS_LOG_FUNCTION.

◆ Serialize()

void ns3::lorawan::LinkCheckAns::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 149 of file mac-command.cc.

References ns3::lorawan::MacCommand::GetCIDFromMacCommand(), ns3::lorawan::MacCommand::m_commandType, m_gwCnt, m_margin, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Data Documentation

◆ m_gwCnt

uint8_t ns3::lorawan::LinkCheckAns::m_gwCnt
private

This MAC command's gateway count value.

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

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

◆ m_margin

uint8_t ns3::lorawan::LinkCheckAns::m_margin
private

This MAC command's demodulation margin value.

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

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


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