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

A class representing a signal in time. More...

#include "lora-interference-helper.h"

+ Inheritance diagram for ns3::lorawan::LoraInterferenceHelper::Event:
+ Collaboration diagram for ns3::lorawan::LoraInterferenceHelper::Event:

Public Member Functions

 Event (Time duration, double rxPowerdBm, uint8_t spreadingFactor, Ptr< Packet > packet, double frequencyMHz)
 Construct a new interference signal Event object.
 
 ~Event ()
 Destructor.
 
Time GetDuration () const
 Get the duration of the event.
 
Time GetEndTime () const
 Get the ending time of the event.
 
double GetFrequency () const
 Get the frequency this event was on.
 
Ptr< PacketGetPacket () const
 Get the packet this event was generated for.
 
double GetRxPowerdBm () const
 Get the power of the event.
 
uint8_t GetSpreadingFactor () const
 Get the spreading factor used by this signal.
 
Time GetStartTime () const
 Get the starting time of the event.
 
void Print (std::ostream &stream) const
 Print the current event in a human readable form.
 
- Public Member Functions inherited from ns3::SimpleRefCount< LoraInterferenceHelper::Event >
 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.
 

Private Attributes

Time m_endTime
 The time this signal ends (at the device).
 
double m_frequencyMHz
 The frequency this event was on.
 
Ptr< Packetm_packet
 The packet this event was generated for.
 
double m_rxPowerdBm
 The power of this event in dBm (at the device).
 
uint8_t m_sf
 The spreading factor of this signal.
 
Time m_startTime
 The time this signal begins (at the device).
 

Detailed Description

A class representing a signal in time.

Used in LoraInterferenceHelper to keep track of which signals overlap and cause destructive interference.

Definition at line 57 of file lora-interference-helper.h.

Constructor & Destructor Documentation

◆ Event()

ns3::lorawan::LoraInterferenceHelper::Event::Event ( Time  duration,
double  rxPowerdBm,
uint8_t  spreadingFactor,
Ptr< Packet packet,
double  frequencyMHz 
)

Construct a new interference signal Event object.

Parameters
durationThe duration in time.
rxPowerdBmThe power of the signal.
spreadingFactorThe modulation spreading factor.
packetThe packet transmitted.
frequencyMHzThe carrier frequency of the signal.

Definition at line 39 of file lora-interference-helper.cc.

◆ ~Event()

ns3::lorawan::LoraInterferenceHelper::Event::~Event ( )

Destructor.

Definition at line 55 of file lora-interference-helper.cc.

Member Function Documentation

◆ GetDuration()

Time ns3::lorawan::LoraInterferenceHelper::Event::GetDuration ( ) const

Get the duration of the event.

Returns
The duration in time.

Definition at line 74 of file lora-interference-helper.cc.

◆ GetEndTime()

Time ns3::lorawan::LoraInterferenceHelper::Event::GetEndTime ( ) const

Get the ending time of the event.

Returns
The end time.

Definition at line 68 of file lora-interference-helper.cc.

◆ GetFrequency()

double ns3::lorawan::LoraInterferenceHelper::Event::GetFrequency ( ) const

Get the frequency this event was on.

Returns
The carrier frequency as a double.

Definition at line 98 of file lora-interference-helper.cc.

◆ GetPacket()

Ptr< Packet > ns3::lorawan::LoraInterferenceHelper::Event::GetPacket ( ) const

Get the packet this event was generated for.

Returns
A pointer to the packet.

Definition at line 92 of file lora-interference-helper.cc.

◆ GetRxPowerdBm()

double ns3::lorawan::LoraInterferenceHelper::Event::GetRxPowerdBm ( ) const

Get the power of the event.

Returns
The power in dBm as a double.

Definition at line 80 of file lora-interference-helper.cc.

◆ GetSpreadingFactor()

uint8_t ns3::lorawan::LoraInterferenceHelper::Event::GetSpreadingFactor ( ) const

Get the spreading factor used by this signal.

Returns
The spreading factor value.

Definition at line 86 of file lora-interference-helper.cc.

◆ GetStartTime()

Time ns3::lorawan::LoraInterferenceHelper::Event::GetStartTime ( ) const

Get the starting time of the event.

Returns
The starting time.

Definition at line 62 of file lora-interference-helper.cc.

◆ Print()

void ns3::lorawan::LoraInterferenceHelper::Event::Print ( std::ostream &  stream) const

Print the current event in a human readable form.

Parameters
streamThe output stream to use.

Definition at line 104 of file lora-interference-helper.cc.

Member Data Documentation

◆ m_endTime

Time ns3::lorawan::LoraInterferenceHelper::Event::m_endTime
private

The time this signal ends (at the device).

Definition at line 135 of file lora-interference-helper.h.

◆ m_frequencyMHz

double ns3::lorawan::LoraInterferenceHelper::Event::m_frequencyMHz
private

The frequency this event was on.

Definition at line 139 of file lora-interference-helper.h.

◆ m_packet

Ptr<Packet> ns3::lorawan::LoraInterferenceHelper::Event::m_packet
private

The packet this event was generated for.

Definition at line 138 of file lora-interference-helper.h.

◆ m_rxPowerdBm

double ns3::lorawan::LoraInterferenceHelper::Event::m_rxPowerdBm
private

The power of this event in dBm (at the device).

Definition at line 137 of file lora-interference-helper.h.

◆ m_sf

uint8_t ns3::lorawan::LoraInterferenceHelper::Event::m_sf
private

The spreading factor of this signal.

Definition at line 136 of file lora-interference-helper.h.

◆ m_startTime

Time ns3::lorawan::LoraInterferenceHelper::Event::m_startTime
private

The time this signal begins (at the device).

Definition at line 134 of file lora-interference-helper.h.


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