This class represents the network server's knowledge about a gateway in the LoRaWAN network it is administering. More...

#include "gateway-status.h"

Inheritance diagram for ns3::lorawan::GatewayStatus:

Collaboration diagram for ns3::lorawan::GatewayStatus:

Public Member Functions
	GatewayStatus ()
	Default constructor.

	GatewayStatus (Address address, Ptr< NetDevice > netDevice, Ptr< GatewayLorawanMac > gwMac)
	Construct a new GatewayStatus object with values.

	~GatewayStatus () override
	Destructor.

Address	GetAddress ()
	Get this gateway's P2P link address.

Ptr< GatewayLorawanMac >	GetGatewayMac ()
	Get a pointer to this gateway's MAC instance.

Ptr< NetDevice >	GetNetDevice ()
	Get the NetDevice through which it's possible to contact this gateway from the server.

bool	IsAvailableForTransmission (double frequency)
	‍**

void	SetAddress (Address address)
	Set this gateway's P2P link address.

void	SetNetDevice (Ptr< NetDevice > netDevice)
	Set the NetDevice through which it's possible to contact this gateway from the server.

void	SetNextTransmissionTime (Time nextTransmissionTime)
	Set the time of the next scheduled transmission for the gateway.

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.

Static Public Member Functions
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.

Private Attributes
Address	m_address
	The Address of the P2PNetDevice of this gateway.

Ptr< GatewayLorawanMac >	m_gatewayMac
	The Mac layer of the gateway.

Ptr< NetDevice >	m_netDevice
	The NetDevice through which to reach this gateway from the server.

Time	m_nextTransmissionTime
	This gateway's next transmission time.

Additional Inherited Members
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.

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

This class represents the network server's knowledge about a gateway in the LoRaWAN network it is administering.

The network server's NetworkStatus component contains a list of instances of this class, one for gateway in the network. Each instance contains all the parameters and information of the gateway. This class is used by the network server for downlink scheduling and sending purposes. That is, to check the gateway's availability for radio transmission, and then to retrieve the correct Net Device to send the packet through.

Definition at line 46 of file gateway-status.h.

Constructor & Destructor Documentation

◆ GatewayStatus() [1/2]

ns3::lorawan::GatewayStatus::GatewayStatus ( )

Default constructor.

Definition at line 39 of file gateway-status.cc.

References NS_LOG_FUNCTION.

◆ ~GatewayStatus()

ns3::lorawan::GatewayStatus::~GatewayStatus ( )

override

Destructor.

Definition at line 44 of file gateway-status.cc.

References NS_LOG_FUNCTION.

◆ GatewayStatus() [2/2]

ns3::lorawan::GatewayStatus::GatewayStatus	(	Address	address,
		Ptr< NetDevice >	netDevice,
		Ptr< GatewayLorawanMac >	gwMac
	)

Construct a new GatewayStatus object with values.

Parameters

address	The Address of the P2PNetDevice of the gateway connected to the network server.
netDevice	A pointer to the NetDevice through which to reach this gateway from the server.
gwMac	A pointer to the MAC layer of the gateway.

Definition at line 49 of file gateway-status.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetAddress()

Address ns3::lorawan::GatewayStatus::GetAddress ( )

Get this gateway's P2P link address.

Returns: The Address instance.

Definition at line 61 of file gateway-status.cc.

References m_address, and NS_LOG_FUNCTION.

◆ GetGatewayMac()

Ptr< GatewayLorawanMac > ns3::lorawan::GatewayStatus::GetGatewayMac ( )

Get a pointer to this gateway's MAC instance.

Returns: A pointer to the MAC layer object.

Definition at line 89 of file gateway-status.cc.

References m_gatewayMac.

◆ GetNetDevice()

Ptr< NetDevice > ns3::lorawan::GatewayStatus::GetNetDevice ( )

Get the NetDevice through which it's possible to contact this gateway from the server.

Returns: A pointer to the NetDevice.

Definition at line 77 of file gateway-status.cc.

References m_netDevice.

◆ GetTypeId()

TypeId ns3::lorawan::GatewayStatus::GetTypeId ( )

static

Register this type.

Returns: The object TypeId.

Definition at line 32 of file gateway-status.cc.

References ns3::TypeId::AddConstructor().

Here is the call graph for this function:

◆ IsAvailableForTransmission()

bool ns3::lorawan::GatewayStatus::IsAvailableForTransmission ( double frequency )

‍**

Query whether or not this gateway is available for immediate transmission on this frequency.

Parameters

frequency The frequency at which the gateway's availability should be queried.

Returns: True if the gateway's available, false otherwise.

Definition at line 95 of file gateway-status.cc.

References ns3::Time::GetSeconds(), m_gatewayMac, m_nextTransmissionTime, ns3::MilliSeconds(), ns3::Simulator::Now(), NS_LOG_INFO, and ns3::Seconds().

Here is the call graph for this function:

◆ SetAddress()

void ns3::lorawan::GatewayStatus::SetAddress ( Address address )

Set this gateway's P2P link address.

Parameters

address The Address instance.

Definition at line 69 of file gateway-status.cc.

References m_address, and NS_LOG_FUNCTION.

◆ SetNetDevice()

void ns3::lorawan::GatewayStatus::SetNetDevice ( Ptr< NetDevice > netDevice )

Set the NetDevice through which it's possible to contact this gateway from the server.

Parameters

netDevice A pointer to the NetDevice.

Definition at line 83 of file gateway-status.cc.

References m_netDevice.

◆ SetNextTransmissionTime()

void ns3::lorawan::GatewayStatus::SetNextTransmissionTime ( Time nextTransmissionTime )

Set the time of the next scheduled transmission for the gateway.

Parameters

nextTransmissionTime The Time value.

Definition at line 127 of file gateway-status.cc.

References m_nextTransmissionTime.

Member Data Documentation

◆ m_address

Address ns3::lorawan::GatewayStatus::m_address

private

The Address of the P2PNetDevice of this gateway.

Definition at line 125 of file gateway-status.h.

Referenced by GetAddress(), and SetAddress().

◆ m_gatewayMac

Ptr<GatewayLorawanMac> ns3::lorawan::GatewayStatus::m_gatewayMac

private

The Mac layer of the gateway.

Definition at line 130 of file gateway-status.h.

Referenced by GetGatewayMac(), and IsAvailableForTransmission().

◆ m_netDevice

Ptr<NetDevice> ns3::lorawan::GatewayStatus::m_netDevice

private

The NetDevice through which to reach this gateway from the server.

Definition at line 128 of file gateway-status.h.

Referenced by GetNetDevice(), and SetNetDevice().

◆ m_nextTransmissionTime

Time ns3::lorawan::GatewayStatus::m_nextTransmissionTime

private

This gateway's next transmission time.

Definition at line 132 of file gateway-status.h.

Referenced by IsAvailableForTransmission(), and SetNextTransmissionTime().

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

src/lorawan/model/gateway-status.h
src/lorawan/model/gateway-status.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GatewayStatus() [1/2]

◆ ~GatewayStatus()

◆ GatewayStatus() [2/2]

Member Function Documentation

◆ GetAddress()

◆ GetGatewayMac()

◆ GetNetDevice()

◆ GetTypeId()

◆ IsAvailableForTransmission()

◆ SetAddress()

◆ SetNetDevice()

◆ SetNextTransmissionTime()

Member Data Documentation

◆ m_address

◆ m_gatewayMac

◆ m_netDevice

◆ m_nextTransmissionTime