INET Framework for OMNeT++/OMNEST
inet::physicallayer::RicianFading Class Reference

This class implements the stochastic Rician fading model. More...

#include <RicianFading.h>

Inheritance diagram for inet::physicallayer::RicianFading:
inet::physicallayer::FreeSpacePathLoss inet::physicallayer::PathLossBase inet::physicallayer::IPathLoss inet::IPrintableObject

Public Member Functions

 RicianFading ()
 
virtual std::ostream & printToStream (std::ostream &stream, int level, int evFlags=0) const override
 Prints this object to the provided output stream. More...
 
virtual double computePathLoss (mps propagationSpeed, Hz frequency, m distance) const override
 Returns the loss factor as a function of propagation speed, carrier frequency and distance. More...
 
- Public Member Functions inherited from inet::physicallayer::FreeSpacePathLoss
 FreeSpacePathLoss ()
 
virtual m computeRange (mps propagationSpeed, Hz frequency, double loss) const override
 Returns the range for the given loss factor. More...
 
- Public Member Functions inherited from inet::physicallayer::PathLossBase
virtual double computePathLoss (const ITransmission *transmission, const IArrival *arrival) const override
 Returns the loss factor for the provided transmission and arrival. More...
 
- Public Member Functions inherited from inet::IPrintableObject
virtual ~IPrintableObject ()
 
virtual std::string printToString () const
 
virtual std::string printToString (int level, int evFlags=0) const
 
virtual std::string getInfoStringRepresentation (int evFlags=0) const
 
virtual std::string getDetailStringRepresentation (int evFlags=0) const
 
virtual std::string getDebugStringRepresentation (int evFlags=0) const
 
virtual std::string getTraceStringRepresentation (int evFlags=0) const
 
virtual std::string getCompleteStringRepresentation (int evFlags=0) const
 

Protected Member Functions

virtual void initialize (int stage) override
 
- Protected Member Functions inherited from inet::physicallayer::FreeSpacePathLoss
virtual double computeFreeSpacePathLoss (m waveLength, m distance, double alpha, double systemLoss) const
 

Protected Attributes

double k
 
- Protected Attributes inherited from inet::physicallayer::FreeSpacePathLoss
double alpha
 
double systemLoss
 

Additional Inherited Members

- Public Types inherited from inet::IPrintableObject
enum  PrintLevel {
  PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,
  PRINT_LEVEL_COMPLETE = INT_MIN
}
 
enum  PrintFlag { PRINT_FLAG_FORMATTED = (1 << 0), PRINT_FLAG_MULTILINE = (1 << 1) }
 

Detailed Description

This class implements the stochastic Rician fading model.

Author
Oliver Graute

Constructor & Destructor Documentation

◆ RicianFading()

inet::physicallayer::RicianFading::RicianFading ( )

Member Function Documentation

◆ computePathLoss()

double inet::physicallayer::RicianFading::computePathLoss ( mps  propagationSpeed,
Hz  frequency,
m  distance 
) const
overridevirtual

Returns the loss factor as a function of propagation speed, carrier frequency and distance.

The value is in the range [0, 1] where 1 means no loss at all and 0 means all power is lost.

Reimplemented from inet::physicallayer::FreeSpacePathLoss.

◆ initialize()

void inet::physicallayer::RicianFading::initialize ( int  stage)
overrideprotectedvirtual

Reimplemented from inet::physicallayer::FreeSpacePathLoss.

47 {
48  m waveLength = propagationSpeed / frequency;
49  double c = 1.0 / (2.0 * (k + 1));
50  double x = normal(0, 1);

◆ printToStream()

std::ostream & inet::physicallayer::RicianFading::printToStream ( std::ostream &  stream,
int  level,
int  evFlags = 0 
) const
overridevirtual

Prints this object to the provided output stream.

Reimplemented from inet::physicallayer::FreeSpacePathLoss.

Member Data Documentation

◆ k

double inet::physicallayer::RicianFading::k
protected

The documentation for this class was generated from the following files:
inet::units::constants::c
const value< double, compose< units::m, pow< units::s, -1 > > > c(299792458)
inet::physicallayer::RicianFading::k
double k
Definition: RicianFading.h:56
inet::units::values::m
value< double, units::m > m
Definition: Units.h:1233