A Discrete-Event Network Simulator
API
ns3::FriisSpectrumPropagationLossModel Class Reference

Friis spectrum propagation loss model. More...

#include "friis-spectrum-propagation-loss.h"

+ Inheritance diagram for ns3::FriisSpectrumPropagationLossModel:
+ Collaboration diagram for ns3::FriisSpectrumPropagationLossModel:

Public Member Functions

 FriisSpectrumPropagationLossModel ()
 
 ~FriisSpectrumPropagationLossModel () override
 
double CalculateLoss (double f, double d) const
 Return the propagation loss L according to a simplified version of Friis' formula in which antenna gains are unitary. More...
 
Ptr< SpectrumValueDoCalcRxPowerSpectralDensity (Ptr< const SpectrumSignalParameters > params, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const override
 
- Public Member Functions inherited from ns3::SpectrumPropagationLossModel
 SpectrumPropagationLossModel ()
 
 ~SpectrumPropagationLossModel () override
 
int64_t AssignStreams (int64_t stream)
 If this loss model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'. More...
 
Ptr< SpectrumValueCalcRxPowerSpectralDensity (Ptr< const SpectrumSignalParameters > params, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const
 This method is to be called to calculate. More...
 
Ptr< SpectrumPropagationLossModelGetNext () const
 Return the pointer to the next SpectrumPropagationLossModel, if any. More...
 
void SetNext (Ptr< SpectrumPropagationLossModel > next)
 Used to chain various instances of SpectrumPropagationLossModel. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::SpectrumPropagationLossModel
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Protected Member Functions

int64_t DoAssignStreams (int64_t stream) override
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
- Protected Member Functions inherited from ns3::SpectrumPropagationLossModel
void DoDispose () override
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Additional Inherited Members

Detailed Description

Friis spectrum propagation loss model.

The propagation loss is calculated according to a simplified version of Friis' formula in which antenna gains are unitary:

$ L = \frac{4 \pi * d * f}{C^2}$

where C = 3e8 m/s is the light speed in the vacuum. The intended use is to calculate Prx = Ptx * G

Definition at line 42 of file friis-spectrum-propagation-loss.h.

Constructor & Destructor Documentation

◆ FriisSpectrumPropagationLossModel()

ns3::FriisSpectrumPropagationLossModel::FriisSpectrumPropagationLossModel ( )

Definition at line 33 of file friis-spectrum-propagation-loss.cc.

◆ ~FriisSpectrumPropagationLossModel()

ns3::FriisSpectrumPropagationLossModel::~FriisSpectrumPropagationLossModel ( )
override

Definition at line 37 of file friis-spectrum-propagation-loss.cc.

Member Function Documentation

◆ CalculateLoss()

double ns3::FriisSpectrumPropagationLossModel::CalculateLoss ( double  f,
double  d 
) const

Return the propagation loss L according to a simplified version of Friis' formula in which antenna gains are unitary.

Parameters
ffrequency in Hz
ddistance in m
Returns
if Prx < Ptx then return Prx; else return Ptx

Definition at line 77 of file friis-spectrum-propagation-loss.cc.

References f(), and NS_ASSERT.

Referenced by DoCalcRxPowerSpectralDensity().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoAssignStreams()

int64_t ns3::FriisSpectrumPropagationLossModel::DoAssignStreams ( int64_t  stream)
overrideprotectedvirtual

Assign a fixed random variable stream number to the random variables used by this model.

Subclasses must implement this; those not using random variables can return zero.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::SpectrumPropagationLossModel.

Definition at line 98 of file friis-spectrum-propagation-loss.cc.

◆ DoCalcRxPowerSpectralDensity()

Ptr< SpectrumValue > ns3::FriisSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity ( Ptr< const SpectrumSignalParameters params,
Ptr< const MobilityModel a,
Ptr< const MobilityModel b 
) const
overridevirtual
Parameters
paramsthe spectrum signal parameters.
asender mobility
breceiver mobility
Returns
set of values Vs frequency representing the received power in the same units used for the txPower parameter.

Implements ns3::SpectrumPropagationLossModel.

Definition at line 52 of file friis-spectrum-propagation-loss.cc.

References CalculateLoss(), ns3::SpectrumValue::ConstBandsBegin(), ns3::SpectrumValue::ConstBandsEnd(), two-ray-to-three-gpp-ch-calibration::fit, NS_ASSERT, two-ray-to-three-gpp-ch-calibration::params, ns3::SpectrumValue::ValuesBegin(), and ns3::SpectrumValue::ValuesEnd().

+ Here is the call graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 42 of file friis-spectrum-propagation-loss.cc.

References ns3::TypeId::SetParent().

Referenced by LtePrimaryCellChangeTestCase::DoRun(), LteSecondaryCellHandoverTestCase::DoRun(), LteSecondaryCellSelectionTestCase::DoRun(), and LteAggregationThroughputScaleTestCase::GetThroughput().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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