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

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< GatewayLorawanMacGetGatewayMac ()
 Get a pointer to this gateway's MAC instance.
 
Ptr< NetDeviceGetNetDevice ()
 Get the NetDevice through which it's possible to contact this gateway from the server.
 
bool IsAvailableForTransmission (double frequency)
 Set a pointer to this gateway's MAC instance.
 
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< 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.
 

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< GatewayLorawanMacm_gatewayMac
 The Mac layer of the gateway.
 
Ptr< NetDevicem_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.
 

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 35 of file gateway-status.h.

Constructor & Destructor Documentation

◆ GatewayStatus() [1/2]

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

Default constructor.

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

References NS_LOG_FUNCTION.

◆ ~GatewayStatus()

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

Destructor.

Definition at line 33 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
addressThe Address of the P2PNetDevice of the gateway connected to the network server.
netDeviceA pointer to the NetDevice through which to reach this gateway from the server.
gwMacA pointer to the MAC layer of the gateway.

Definition at line 38 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 50 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 78 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 66 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 21 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)

Set a pointer to this gateway's MAC instance.

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

Parameters
frequencyThe frequency at which the gateway's availability should be queried.
Returns
True if the gateway's available, false otherwise.

Definition at line 84 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
addressThe Address instance.

Definition at line 58 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
netDeviceA pointer to the NetDevice.

Definition at line 72 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
nextTransmissionTimeThe Time value.

Definition at line 116 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 114 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 119 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 117 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 121 of file gateway-status.h.

Referenced by IsAvailableForTransmission(), and SetNextTransmissionTime().


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