A Discrete-Event Network Simulator
API
ns3::InterferenceHelper::NiChange Class Reference

Noise and Interference (thus Ni) event. More...

+ Collaboration diagram for ns3::InterferenceHelper::NiChange:

Public Member Functions

 NiChange (double power, Ptr< Event > event)
 Create a NiChange at the given time and the amount of NI change. More...
 
void AddPower (double power)
 Add a given amount of power. More...
 
Ptr< EventGetEvent (void) const
 Return the event causes the corresponding NI change. More...
 
double GetPower (void) const
 Return the power. More...
 

Private Attributes

Ptr< Eventm_event
 event More...
 
double m_power
 power in watts More...
 

Detailed Description

Noise and Interference (thus Ni) event.

Definition at line 249 of file interference-helper.h.

Constructor & Destructor Documentation

◆ NiChange()

ns3::InterferenceHelper::NiChange::NiChange ( double  power,
Ptr< Event event 
)

Create a NiChange at the given time and the amount of NI change.

Parameters
powerthe power in watts
eventcauses this NI change

Definition at line 109 of file interference-helper.cc.

Member Function Documentation

◆ AddPower()

void ns3::InterferenceHelper::NiChange::AddPower ( double  power)

Add a given amount of power.

Parameters
powerthe power to be added to the existing value in watts

Definition at line 122 of file interference-helper.cc.

◆ GetEvent()

Ptr< Event > ns3::InterferenceHelper::NiChange::GetEvent ( void  ) const

Return the event causes the corresponding NI change.

Returns
the event

Definition at line 128 of file interference-helper.cc.

◆ GetPower()

double ns3::InterferenceHelper::NiChange::GetPower ( void  ) const

Return the power.

Returns
the power in watts

Definition at line 116 of file interference-helper.cc.

Member Data Documentation

◆ m_event

Ptr<Event> ns3::InterferenceHelper::NiChange::m_event
private

event

Definition at line 281 of file interference-helper.h.

◆ m_power

double ns3::InterferenceHelper::NiChange::m_power
private

power in watts

Definition at line 280 of file interference-helper.h.


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