ns3::SatConstantInterference Class Reference

Satellite constant interference. More...

#include "satellite-constant-interference.h"

+ Inheritance diagram for ns3::SatConstantInterference:
+ Collaboration diagram for ns3::SatConstantInterference:

Public Member Functions

 SatConstantInterference ()
 Default constructor. More...
 
 ~SatConstantInterference ()
 Destructor for SatConstantInterference. More...
 
TypeId GetInstanceTypeId (void) const
 
- Public Member Functions inherited from ns3::SatInterference
 SatInterference ()
 Constructor for Satellite interference base class. More...
 
 ~SatInterference ()
 Destructor for Satellite interference base class. More...
 
Ptr< SatInterference::InterferenceChangeEventAdd (Time rxDuration, double rxPower, Address rxAddress)
 Adds interference power to interference object. More...
 
std::vector< std::pair< double, double > > Calculate (Ptr< SatInterference::InterferenceChangeEvent > event)
 Calculates interference power for the given reference. More...
 
TypeId GetInstanceTypeId (void) const
 Derived from Object. More...
 
virtual bool HasCollision (Ptr< SatInterference::InterferenceChangeEvent > event)
 Checks whether the packet has collided. More...
 
virtual void NotifyRxEnd (Ptr< SatInterference::InterferenceChangeEvent > event)
 Notifies that RX is ended by a receiver. More...
 
virtual void NotifyRxStart (Ptr< SatInterference::InterferenceChangeEvent > event)
 Notifies that RX is started by a receiver. More...
 
void Reset (void)
 Resets current interference. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::SatInterference
static TypeId GetTypeId (void)
 Derived from Object. More...
 

Private Member Functions

 SatConstantInterference (const SatConstantInterference &o)
 
virtual Ptr< SatInterference::InterferenceChangeEventDoAdd (Time rxDuration, double rxPower, Address rxAddress)
 Adds interference power to interference object. More...
 
virtual std::vector< std::pair< double, double > > DoCalculate (Ptr< SatInterference::InterferenceChangeEvent > event)
 Calculates interference power for the given reference Sets final power at end time to finalPower. More...
 
virtual void DoNotifyRxEnd (Ptr< SatInterference::InterferenceChangeEvent > event)
 Notifies that RX is ended by a receiver. More...
 
virtual void DoNotifyRxStart (Ptr< SatInterference::InterferenceChangeEvent > event)
 Notifies that RX is started by a receiver. More...
 
virtual void DoReset (void)
 Resets current interference. More...
 
SatConstantInterferenceoperator= (const SatConstantInterference &o)
 

Private Attributes

double m_power
 
bool m_rxing
 

Detailed Description

Satellite constant interference.

Interference is constant until set again by an attribute.

Definition at line 36 of file satellite-constant-interference.h.

Constructor & Destructor Documentation

◆ SatConstantInterference() [1/2]

ns3::SatConstantInterference::SatConstantInterference ( )

Default constructor.

Definition at line 56 of file satellite-constant-interference.cc.

◆ ~SatConstantInterference()

ns3::SatConstantInterference::~SatConstantInterference ( )

Destructor for SatConstantInterference.

Definition at line 62 of file satellite-constant-interference.cc.

References ns3::SatInterference::Reset().

+ Here is the call graph for this function:

◆ SatConstantInterference() [2/2]

ns3::SatConstantInterference::SatConstantInterference ( const SatConstantInterference o)
private

Member Function Documentation

◆ DoAdd()

Ptr< SatInterference::InterferenceChangeEvent > ns3::SatConstantInterference::DoAdd ( Time  rxDuration,
double  rxPower,
Address  rxAddress 
)
privatevirtual

Adds interference power to interference object.

No effect in this implementation.

Parameters
rxDurationDuration of the receiving.
rxPowerReceiving power.
rxAddress
Returns
the pointer to interference event as a reference of the addition

Implements ns3::SatInterference.

Definition at line 68 of file satellite-constant-interference.cc.

◆ DoCalculate()

std::vector< std::pair< double, double > > ns3::SatConstantInterference::DoCalculate ( Ptr< SatInterference::InterferenceChangeEvent event)
privatevirtual

Calculates interference power for the given reference Sets final power at end time to finalPower.

Just return constant value set by Set method in this implementation. finalPower is set to returned value.

Parameters
eventReference event which for interference is calculated.
Returns
Final power value at end of receiving

Implements ns3::SatInterference.

Definition at line 79 of file satellite-constant-interference.cc.

References m_power, and m_rxing.

◆ DoNotifyRxEnd()

void ns3::SatConstantInterference::DoNotifyRxEnd ( Ptr< SatInterference::InterferenceChangeEvent event)
privatevirtual

Notifies that RX is ended by a receiver.

Parameters
eventInterference reference event of receiver (ignored in this implementation)

Implements ns3::SatInterference.

Definition at line 112 of file satellite-constant-interference.cc.

References m_rxing.

◆ DoNotifyRxStart()

void ns3::SatConstantInterference::DoNotifyRxStart ( Ptr< SatInterference::InterferenceChangeEvent event)
privatevirtual

Notifies that RX is started by a receiver.

Parameters
eventInterference reference event of receiver (ignored in this implementation)

Implements ns3::SatInterference.

Definition at line 104 of file satellite-constant-interference.cc.

References m_rxing.

◆ DoReset()

void ns3::SatConstantInterference::DoReset ( void  )
privatevirtual

Resets current interference.

Implements ns3::SatInterference.

Definition at line 96 of file satellite-constant-interference.cc.

References m_rxing.

◆ GetInstanceTypeId()

TypeId ns3::SatConstantInterference::GetInstanceTypeId ( void  ) const

Definition at line 51 of file satellite-constant-interference.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::SatConstantInterference::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 37 of file satellite-constant-interference.cc.

References m_power.

Referenced by GetInstanceTypeId().

+ Here is the caller graph for this function:

◆ operator=()

SatConstantInterference& ns3::SatConstantInterference::operator= ( const SatConstantInterference o)
private

Member Data Documentation

◆ m_power

double ns3::SatConstantInterference::m_power
private

Definition at line 109 of file satellite-constant-interference.h.

Referenced by DoCalculate(), and GetTypeId().

◆ m_rxing

bool ns3::SatConstantInterference::m_rxing
private

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