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

#include "mac-command.h"

Inheritance diagram for ns3::lorawan::LinkAdrAns:

Collaboration diagram for ns3::lorawan::LinkAdrAns:

Public Member Functions
	LinkAdrAns ()
	Default constructor.

	LinkAdrAns (bool powerAck, bool dataRateAck, bool channelMaskAck)
	Constructor with given fields.

uint8_t	Deserialize (Buffer::Iterator &start) override
	Deserialize the buffer into a 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< 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, 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
bool	m_channelMaskAck
	The ChannelMaskACK field.

bool	m_dataRateAck
	The DataRateACK field.

bool	m_powerAck
	The PowerACK 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 Symbols 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 LinkAdrAns LoRaWAN MAC command.

With this command, the end device acknowledges a LinkAdrReq.

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

Constructor & Destructor Documentation

◆ LinkAdrAns() [1/2]

ns3::lorawan::LinkAdrAns::LinkAdrAns ( )

Default constructor.

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

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

◆ LinkAdrAns() [2/2]

ns3::lorawan::LinkAdrAns::LinkAdrAns	(	bool	powerAck,
		bool	dataRateAck,
		bool	channelMaskAck )

Constructor with given fields.

Parameters

powerAck	The PowerACK field to set.
dataRateAck	The DataRateACK field to set.
channelMaskAck	The ChannelMaskACK field to set.

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

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

Member Function Documentation

◆ Deserialize()

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

References m_channelMaskAck, m_dataRateAck, m_powerAck, ns3::lorawan::MacCommand::m_serializedSize, and NS_LOG_FUNCTION_NOARGS.

◆ Print()

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

References NS_LOG_FUNCTION_NOARGS.

◆ Serialize()

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

References ns3::lorawan::MacCommand::GetCIDFromMacCommand(), m_channelMaskAck, ns3::lorawan::MacCommand::m_commandType, m_dataRateAck, m_powerAck, and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

Member Data Documentation

◆ m_channelMaskAck

bool ns3::lorawan::LinkAdrAns::m_channelMaskAck

private

The ChannelMaskACK field.

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

Referenced by Deserialize(), and Serialize().

◆ m_dataRateAck

bool ns3::lorawan::LinkAdrAns::m_dataRateAck

private

The DataRateACK field.

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

Referenced by Deserialize(), and Serialize().

◆ m_powerAck

bool ns3::lorawan::LinkAdrAns::m_powerAck

private

The PowerACK field.

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

Referenced by Deserialize(), 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

◆ LinkAdrAns() [1/2]

◆ LinkAdrAns() [2/2]

Member Function Documentation

◆ Deserialize()

◆ Print()

◆ Serialize()

Member Data Documentation

◆ m_channelMaskAck

◆ m_dataRateAck

◆ m_powerAck