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 ()

	RxParamSetupReq (uint8_t rx1DrOffset, uint8_t rx2DataRate, double frequency)
	Constructor providing initialization of all fields.

uint8_t	Deserialize (Buffer::Iterator &start) override
	Deserialize the buffer into a MAC command.

double	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 uint8_t	Deserialize (Buffer::Iterator &start)=0
	Deserialize the buffer into a MAC command.

virtual enum MacCommandType	GetCommandType () const
	Get the commandType of this MAC command.

virtual uint8_t	GetSerializedSize () const
	Get serialized length of this MAC command.

virtual void	Print (std::ostream &os) const =0
	Print the contents of this MAC command in human-readable format.

virtual void	Serialize (Buffer::Iterator &start) const =0
	Serialize the contents of this MAC command into a buffer, according to the LoRaWAN standard.

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< Object >	GetObject () 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< Object >	GetObject (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.

SimpleRefCount &	operator= (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) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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
double	m_frequency
	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.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Implementation of the RxParamSetupReq 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 381 of file mac-command.h.

Constructor & Destructor Documentation

◆ RxParamSetupReq() [1/2]

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

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

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

◆ RxParamSetupReq() [2/2]

ns3::lorawan::RxParamSetupReq::RxParamSetupReq	(	uint8_t	rx1DrOffset,
		uint8_t	rx2DataRate,
		double	frequency
	)

Constructor providing initialization of all fields.

Parameters

rx1DrOffset	The data rate offset to use for the first receive window.
rx2DataRate	The data rate to use for the second receive window.
frequency	The frequency in Hz to use for the second receive window.

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

References ns3::lorawan::MacCommand::m_commandType, ns3::lorawan::MacCommand::m_serializedSize, NS_LOG_FUNCTION, NS_LOG_WARN, 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

start A pointer to the buffer that contains the serialized command.

Returns: The number of bytes that were consumed.

Implements ns3::lorawan::MacCommand.

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

References m_frequency, m_rx1DrOffset, m_rx2DataRate, ns3::lorawan::MacCommand::m_serializedSize, NS_LOG_DEBUG, and NS_LOG_FUNCTION_NOARGS.

◆ GetFrequency()

double ns3::lorawan::RxParamSetupReq::GetFrequency ( )

Get this command's frequency.

Returns: The frequency parameter, in Hz.

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

References m_frequency, and NS_LOG_FUNCTION.

◆ GetRx1DrOffset()

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

Get this command's Rx1DrOffset parameter.

Returns: The Rx1DrOffset parameter.

Definition at line 634 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 642 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

os	The std::ostream instance on which to print the MAC command.

Implements ns3::lorawan::MacCommand.

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

References m_frequency, m_rx1DrOffset, m_rx2DataRate, and NS_LOG_FUNCTION_NOARGS.

◆ 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

start A pointer to the buffer into which to serialize the command.

Implements ns3::lorawan::MacCommand.

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

References ns3::lorawan::MacCommand::GetCIDFromMacCommand(), ns3::lorawan::MacCommand::m_commandType, m_frequency, m_rx1DrOffset, m_rx2DataRate, NS_LOG_DEBUG, and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

Member Data Documentation

◆ m_frequency

double ns3::lorawan::RxParamSetupReq::m_frequency

private

The Frequency field, in Hz

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

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

◆ m_rx1DrOffset

uint8_t ns3::lorawan::RxParamSetupReq::m_rx1DrOffset

private

The RX1DROffset field.

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

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

◆ m_rx2DataRate

uint8_t ns3::lorawan::RxParamSetupReq::m_rx2DataRate

private

The RX2DataRate field.

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

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

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

src/lorawan/model/mac-command.h
src/lorawan/model/mac-command.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RxParamSetupReq() [1/2]

◆ RxParamSetupReq() [2/2]

Member Function Documentation

◆ Deserialize()

◆ GetFrequency()

◆ GetRx1DrOffset()

◆ GetRx2DataRate()

◆ Print()

◆ Serialize()

Member Data Documentation

◆ m_frequency

◆ m_rx1DrOffset

◆ m_rx2DataRate