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

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

#include "mac-command.h"

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

Public Member Functions

 RxParamSetupReq ()
 Default constructor.
 
 RxParamSetupReq (uint8_t rx1DrOffset, uint8_t rx2DataRate, uint32_t frequencyHz)
 Constructor providing initialization of all fields.
 
uint8_t Deserialize (Buffer::Iterator &start) override
 Deserialize the buffer into a MAC command.
 
uint32_t GetFrequency ()
 Get this command's frequency.
 
uint8_t GetRx1DrOffset ()
 Get this command's Rx1DrOffset parameter.
 
uint8_t GetRx2DataRate ()
 Get this command's Rx2DataRate parameter.
 
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 final
 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

uint32_t m_frequencyHz
 The Frequency field, in Hz
 
uint8_t m_rx1DrOffset
 The RX1DROffset field.
 
uint8_t m_rx2DataRate
 The RX2DataRate 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 RxParamSetupReq LoRaWAN MAC command.

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

Constructor & Destructor Documentation

◆ RxParamSetupReq() [1/2]

ns3::lorawan::RxParamSetupReq::RxParamSetupReq ( )

◆ RxParamSetupReq() [2/2]

ns3::lorawan::RxParamSetupReq::RxParamSetupReq ( uint8_t rx1DrOffset,
uint8_t rx2DataRate,
uint32_t frequencyHz )

Constructor providing initialization of all fields.

Parameters
rx1DrOffsetThe data rate offset to use for the first receive window.
rx2DataRateThe data rate to use for the second receive window.
frequencyHzThe frequency in Hz to use for the second receive window.

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

References ns3::lorawan::MacCommand::m_commandType, m_frequencyHz, m_rx1DrOffset, m_rx2DataRate, ns3::lorawan::MacCommand::m_serializedSize, NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::lorawan::RX_PARAM_SETUP_REQ.

Member Function Documentation

◆ Deserialize()

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

References m_frequencyHz, m_rx1DrOffset, m_rx2DataRate, ns3::lorawan::MacCommand::m_serializedSize, and NS_LOG_FUNCTION.

◆ GetFrequency()

uint32_t ns3::lorawan::RxParamSetupReq::GetFrequency ( )

Get this command's frequency.

Returns
The frequency parameter, in Hz.

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

References m_frequencyHz, and NS_LOG_FUNCTION.

◆ GetRx1DrOffset()

uint8_t ns3::lorawan::RxParamSetupReq::GetRx1DrOffset ( )

Get this command's Rx1DrOffset parameter.

Returns
The Rx1DrOffset parameter.

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

References m_rx1DrOffset, and NS_LOG_FUNCTION.

◆ GetRx2DataRate()

uint8_t ns3::lorawan::RxParamSetupReq::GetRx2DataRate ( )

Get this command's Rx2DataRate parameter.

Returns
The Rx2DataRate parameter.

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

References m_rx2DataRate, and NS_LOG_FUNCTION.

◆ Print()

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

References m_frequencyHz, m_rx1DrOffset, m_rx2DataRate, and NS_LOG_FUNCTION.

◆ Serialize()

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

References ns3::lorawan::MacCommand::GetCIDFromMacCommand(), ns3::lorawan::MacCommand::m_commandType, m_frequencyHz, m_rx1DrOffset, m_rx2DataRate, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_frequencyHz

uint32_t ns3::lorawan::RxParamSetupReq::m_frequencyHz
private

The Frequency field, in Hz

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

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

◆ m_rx1DrOffset

uint8_t ns3::lorawan::RxParamSetupReq::m_rx1DrOffset
private

The RX1DROffset field.

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

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

◆ m_rx2DataRate

uint8_t ns3::lorawan::RxParamSetupReq::m_rx2DataRate
private

The RX2DataRate field.

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

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


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