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

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

#include "mac-command.h"

Inheritance diagram for ns3::lorawan::NewChannelAns:
Collaboration diagram for ns3::lorawan::NewChannelAns:

Public Member Functions

 NewChannelAns ()
 Default constructor.
 NewChannelAns (bool dataRateRangeOk, bool channelFrequencyOk)
 Constructor providing initialization of all parameters.
uint8_t Deserialize (Buffer::Iterator &start) override
 Deserialize the buffer into a MAC command.
bool GetChannelFrequencyOk () const
 Get the ChannelFrequencyOk field of the NewChannelAns command.
bool GetDataRateRangeOk () const
 Get the DataRateRangOk field of the NewChannelAns 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.
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
void Ref () const
 Increment the reference count.
void Unref () const
 Decrement the reference count.

Private Attributes

bool m_channelFrequencyOk
 The Channel frequency ok field.
bool m_dataRateRangeOk
 The Data-rate range ok field.

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 NewChannelAns LoRaWAN MAC command.

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

Constructor & Destructor Documentation

◆ NewChannelAns() [1/2]

ns3::lorawan::NewChannelAns::NewChannelAns ( )

◆ NewChannelAns() [2/2]

ns3::lorawan::NewChannelAns::NewChannelAns ( bool dataRateRangeOk,
bool channelFrequencyOk )

Constructor providing initialization of all parameters.

Parameters
dataRateRangeOkWhether or not the requested data rate range was set correctly.
channelFrequencyOkWhether or not the requested channel frequency was set correctly.

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

References m_channelFrequencyOk, ns3::lorawan::MacCommand::m_commandType, m_dataRateRangeOk, ns3::lorawan::MacCommand::m_serializedSize, ns3::lorawan::NEW_CHANNEL_ANS, and NS_LOG_FUNCTION.

Member Function Documentation

◆ Deserialize()

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

References m_channelFrequencyOk, m_dataRateRangeOk, ns3::lorawan::MacCommand::m_serializedSize, and NS_LOG_FUNCTION.

◆ GetChannelFrequencyOk()

bool ns3::lorawan::NewChannelAns::GetChannelFrequencyOk ( ) const

Get the ChannelFrequencyOk field of the NewChannelAns command.

Returns
true The end-device is able to use this frequency.
false The end-device cannot use this frequency.

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

References m_channelFrequencyOk, and NS_LOG_FUNCTION.

◆ GetDataRateRangeOk()

bool ns3::lorawan::NewChannelAns::GetDataRateRangeOk ( ) const

Get the DataRateRangOk field of the NewChannelAns command.

Returns
true The data-rate range is compatible with the capabilities of the end-device.
false The designated data-rate range exceeds the ones currently defined for this end-device.

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

References m_dataRateRangeOk, and NS_LOG_FUNCTION.

◆ Print()

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

References m_channelFrequencyOk, m_dataRateRangeOk, and NS_LOG_FUNCTION.

◆ Serialize()

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

References ns3::lorawan::MacCommand::GetCIDFromMacCommand(), m_channelFrequencyOk, ns3::lorawan::MacCommand::m_commandType, m_dataRateRangeOk, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Data Documentation

◆ m_channelFrequencyOk

bool ns3::lorawan::NewChannelAns::m_channelFrequencyOk
private

The Channel frequency ok field.

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

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

◆ m_dataRateRangeOk

bool ns3::lorawan::NewChannelAns::m_dataRateRangeOk
private

The Data-rate range ok field.

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

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


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