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

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

#include "mac-command.h"

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

Public Member Functions

 LinkCheckAns ()
 Default constructor.
 
 LinkCheckAns (uint8_t margin, uint8_t gwCnt)
 Constructor with given fields.
 
uint8_t Deserialize (Buffer::Iterator &start) override
 Deserialize the buffer into a MAC command.
 
uint8_t GetGwCnt () const
 Get the gateway count value.
 
uint8_t GetMargin () const
 Get the demodulation margin value.
 
void IncrementGwCnt ()
 Increment this MacCommand's gwCnt value.
 
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.
 
void SetGwCnt (uint8_t gwCnt)
 Set the gateway count value.
 
void SetMargin (uint8_t margin)
 Set the demodulation margin value.
 
- 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_gwCnt
 This MAC command's gateway count value.
 
uint8_t m_margin
 This MAC command's demodulation margin value.
 

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

This command contains the demodulation margin and the number of receiving gateways of the packet containing the LinkCheckReq command.

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

Constructor & Destructor Documentation

◆ LinkCheckAns() [1/2]

ns3::lorawan::LinkCheckAns::LinkCheckAns ( )

◆ LinkCheckAns() [2/2]

ns3::lorawan::LinkCheckAns::LinkCheckAns ( uint8_t margin,
uint8_t gwCnt )

Constructor with given fields.

Parameters
marginThe demodulation margin to set.
gwCntThe gateway count to set.

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

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

Member Function Documentation

◆ Deserialize()

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

References m_gwCnt, m_margin, ns3::lorawan::MacCommand::m_serializedSize, and NS_LOG_FUNCTION_NOARGS.

◆ GetGwCnt()

uint8_t ns3::lorawan::LinkCheckAns::GetGwCnt ( ) const

Get the gateway count value.

Returns
The gateway count value.

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

References m_gwCnt, and NS_LOG_FUNCTION.

◆ GetMargin()

uint8_t ns3::lorawan::LinkCheckAns::GetMargin ( ) const

Get the demodulation margin value.

Returns
The demodulation margin value.

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

References m_margin, and NS_LOG_FUNCTION.

◆ IncrementGwCnt()

void ns3::lorawan::LinkCheckAns::IncrementGwCnt ( )

Increment this MacCommand's gwCnt value.

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

References m_gwCnt, and NS_LOG_FUNCTION.

◆ Print()

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

References m_gwCnt, m_margin, and NS_LOG_FUNCTION_NOARGS.

◆ Serialize()

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

References ns3::lorawan::MacCommand::GetCIDFromMacCommand(), ns3::lorawan::MacCommand::m_commandType, m_gwCnt, m_margin, and NS_LOG_FUNCTION_NOARGS.

+ Here is the call graph for this function:

◆ SetGwCnt()

void ns3::lorawan::LinkCheckAns::SetGwCnt ( uint8_t gwCnt)

Set the gateway count value.

Parameters
gwCntThe count value to set.

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

References m_gwCnt, and NS_LOG_FUNCTION.

◆ SetMargin()

void ns3::lorawan::LinkCheckAns::SetMargin ( uint8_t margin)

Set the demodulation margin value.

Parameters
marginThe demodulation margin to set.

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

References m_margin, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_gwCnt

uint8_t ns3::lorawan::LinkCheckAns::m_gwCnt
private

This MAC command's gateway count value.

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

Referenced by Deserialize(), GetGwCnt(), IncrementGwCnt(), Print(), Serialize(), and SetGwCnt().

◆ m_margin

uint8_t ns3::lorawan::LinkCheckAns::m_margin
private

This MAC command's demodulation margin value.

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

Referenced by Deserialize(), GetMargin(), Print(), Serialize(), and SetMargin().


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