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

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

#include "mac-command.h"

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

Public Member Functions

 NewChannelReq ()
 
 NewChannelReq (uint8_t chIndex, double frequency, uint8_t minDataRate, uint8_t maxDataRate)
 Constructor providing initialization of all parameters.
 
uint8_t Deserialize (Buffer::Iterator &start) override
 Deserialize the buffer into a MAC command.
 
uint8_t GetChannelIndex () const
 Get the the ChIndex field contained in this MAC command.
 
double GetFrequency () const
 Get the the Frequency field contained in this MAC command.
 
uint8_t GetMaxDataRate () const
 Get the the MaxDR field contained in this MAC command.
 
uint8_t GetMinDataRate () const
 Get the the MinDR field contained in 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

uint8_t m_chIndex
 The ChIndex field.
 
double m_frequency
 The Frequency field, in Hz.
 
uint8_t m_maxDataRate
 The MaxDR field.
 
uint8_t m_minDataRate
 The MinDR 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.
 
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 NewChannelReq LoRaWAN MAC command.

Todo
The use of frequencies in Hz here will cause problems for users, as frequencies are in MHz in the rest of the module code. IMO it would be better to have freqs in Hz as uint32_t

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

Constructor & Destructor Documentation

◆ NewChannelReq() [1/2]

ns3::lorawan::NewChannelReq::NewChannelReq ( )

◆ NewChannelReq() [2/2]

ns3::lorawan::NewChannelReq::NewChannelReq ( uint8_t chIndex,
double frequency,
uint8_t minDataRate,
uint8_t maxDataRate )

Constructor providing initialization of all parameters.

Parameters
chIndexThe index of the channel this command wants to operate on.
frequencyThe new frequency for this channel in Hz.
minDataRateThe minimum data rate allowed on this channel.
maxDataRateThe maximum data rate allowed on this channel.

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

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

Member Function Documentation

◆ Deserialize()

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

References m_chIndex, m_frequency, m_maxDataRate, m_minDataRate, ns3::lorawan::MacCommand::m_serializedSize, and NS_LOG_FUNCTION_NOARGS.

◆ GetChannelIndex()

uint8_t ns3::lorawan::NewChannelReq::GetChannelIndex ( ) const

Get the the ChIndex field contained in this MAC command.

Returns
The ChIndex field.

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

References m_chIndex, and NS_LOG_FUNCTION_NOARGS.

◆ GetFrequency()

double ns3::lorawan::NewChannelReq::GetFrequency ( ) const

Get the the Frequency field contained in this MAC command.

Returns
The Frequency field in Hz.

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

References m_frequency, and NS_LOG_FUNCTION_NOARGS.

◆ GetMaxDataRate()

uint8_t ns3::lorawan::NewChannelReq::GetMaxDataRate ( ) const

Get the the MaxDR field contained in this MAC command.

Returns
The MaxDR field.

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

References m_maxDataRate, and NS_LOG_FUNCTION_NOARGS.

◆ GetMinDataRate()

uint8_t ns3::lorawan::NewChannelReq::GetMinDataRate ( ) const

Get the the MinDR field contained in this MAC command.

Returns
The MinDR field.

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

References m_minDataRate, and NS_LOG_FUNCTION_NOARGS.

◆ Print()

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

References NS_LOG_FUNCTION_NOARGS.

◆ Serialize()

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

References ns3::lorawan::MacCommand::GetCIDFromMacCommand(), m_chIndex, ns3::lorawan::MacCommand::m_commandType, m_frequency, m_maxDataRate, m_minDataRate, and NS_LOG_FUNCTION_NOARGS.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_chIndex

uint8_t ns3::lorawan::NewChannelReq::m_chIndex
private

The ChIndex field.

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

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

◆ m_frequency

double ns3::lorawan::NewChannelReq::m_frequency
private

The Frequency field, in Hz.

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

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

◆ m_maxDataRate

uint8_t ns3::lorawan::NewChannelReq::m_maxDataRate
private

The MaxDR field.

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

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

◆ m_minDataRate

uint8_t ns3::lorawan::NewChannelReq::m_minDataRate
private

The MinDR field.

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

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


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