inet::physicallayer::FrequencyDependentAttenuationFunction Class Reference

This mathematical function provides the signal attenuation for any given time and frequency coordinates. More...

#include <PowerFunctions.h>

Inheritance diagram for inet::physicallayer::FrequencyDependentAttenuationFunction:

Public Member Functions
	FrequencyDependentAttenuationFunction (const IRadioMedium *radioMedium, const double transmitterAntennaGain, const double receiverAntennaGain, const Coord &transmissionPosition, const Coord &receptionPosition)
virtual double	getValue (const Point< simsec, Hz > &p) const override
virtual bool	isFinite (const Interval< simsec, Hz > &i) const override
virtual void	printStructure (std::ostream &os, int level=0) const override
	Prints the internal data structure of this function in a human readable form to the provided stream. More...
Public Member Functions inherited from inet::math::FunctionBase< double, Domain< simsec, Hz > >
virtual void	partition (const typename Domain< simsec, Hz > ::I &i, const std::function< void(const typename Domain< simsec, Hz > ::I &, const IFunction< double, Domain< simsec, Hz > > *)> callback) const override
	Subdivides the provided domain and calls back f with the subdomains and the corresponding potentially simpler domain limited functions. More...
virtual Interval< double >	getRange () const override
	Returns the valid range of the function as an interval. More...
virtual Interval< double >	getRange (const typename Domain< simsec, Hz > ::I &i) const override
	Returns the valid range of the function as an interval for the given domain. More...
virtual Domain< simsec, Hz > ::I	getDomain () const override
	Returns the valid domain of the function as an interval. More...
virtual bool	isFinite () const override
	Returns true if the function value is finite in the whole domain. More...
virtual bool	isFinite (const typename Domain< simsec, Hz > ::I &i) const override
	Returns true if the function value is finite in the given domain. More...
virtual bool	isNonZero () const override
	Returns true if the function value is non-zero in the whole domain. More...
virtual bool	isNonZero (const typename Domain< simsec, Hz > ::I &i) const override
	Returns true if the function value is non-zero in the given domain. More...
virtual double	getMin () const override
	Returns the minimum value for the whole domain. More...
virtual double	getMin (const typename Domain< simsec, Hz > ::I &i) const override
	Returns the minimum value for the given domain. More...
virtual double	getMax () const override
	Returns the maximum value for the whole domain. More...
virtual double	getMax (const typename Domain< simsec, Hz > ::I &i) const override
	Returns the maximum value for the given domain. More...
virtual double	getMean () const override
	Returns the mean value for the whole domain. More...
virtual double	getMean (const typename Domain< simsec, Hz > ::I &i) const override
	Returns the mean value for the given domain. More...
virtual double	getIntegral () const override
	Returns the integral value for the whole domain. More...
virtual double	getIntegral (const typename Domain< simsec, Hz > ::I &i) const override
	Returns the integral value for the given domain. More...
virtual const Ptr< const IFunction< double, Domain< simsec, Hz > > >	add (const Ptr< const IFunction< double, Domain< simsec, Hz > >> &o) const override
	Adds the provided function to this function. More...
virtual const Ptr< const IFunction< double, Domain< simsec, Hz > > >	subtract (const Ptr< const IFunction< double, Domain< simsec, Hz > >> &o) const override
	Substracts the provided function from this function. More...
virtual const Ptr< const IFunction< double, Domain< simsec, Hz > > >	multiply (const Ptr< const IFunction< double, Domain< simsec, Hz > >> &o) const override
	Multiplies the provided function with this function. More...
virtual const Ptr< const IFunction< double, Domain< simsec, Hz > > >	divide (const Ptr< const IFunction< double, Domain< simsec, Hz > >> &o) const override
	Divides this function with the provided function. More...
virtual std::ostream &	printOn (std::ostream &os) const override
virtual void	print (std::ostream &os, int level=0) const override
	Prints this function in human readable form to the provided stream for the whole domain. More...
virtual void	print (std::ostream &os, const typename Domain< simsec, Hz > ::I &i, int level=0) const override
	Prints this function in a human readable form to the provided stream for the given domain. More...
virtual void	printPartitioning (std::ostream &os, const typename Domain< simsec, Hz > ::I &i, int level) const override
	Prints the partitioning of this function in a human readable form to the provided stream for the given domain. More...
virtual void	printPartition (std::ostream &os, const typename Domain< simsec, Hz > ::I &i, int level=0) const override
	Prints a single partition of this function in a human readable form to the provided stream for the given domain. More...
Public Member Functions inherited from inet::math::IFunction< double, Domain< simsec, Hz > >
virtual	~IFunction ()
virtual double	getValue (const typename Domain< simsec, Hz > ::P &p) const=0
	Returns the value of the function at the given point. More...

Protected Attributes
const IRadioMedium *	radioMedium = nullptr
const double	transmitterAntennaGain
const double	receiverAntennaGain
const Coord	transmissionPosition
const Coord	receptionPosition
const m	distance

Detailed Description

This mathematical function provides the signal attenuation for any given time and frequency coordinates.

This function assumes the transmitter and the receiver are stationary for the duration of the transmission and the reception. The function value is not time dependent but having the time dimension in this definition simplifies further computations.

Constructor & Destructor Documentation

FrequencyDependentAttenuationFunction()

inet::physicallayer::FrequencyDependentAttenuationFunction::FrequencyDependentAttenuationFunction ( const IRadioMedium *  radioMedium, const double  transmitterAntennaGain, const double  receiverAntennaGain, const Coord &  transmissionPosition, const Coord &  receptionPosition  )

inline

                                                                                                                                                                                                                     :
        radioMedium(radioMedium), transmitterAntennaGain(transmitterAntennaGain), receiverAntennaGain(receiverAntennaGain), transmissionPosition(transmissionPosition), receptionPosition(receptionPosition), distance(m(transmissionPosition.distance(receptionPosition)))
    {
    }

Member Function Documentation

getValue()

virtual double inet::physicallayer::FrequencyDependentAttenuationFunction::getValue ( const Point< simsec, Hz > &  p ) const

inlineoverridevirtual

                                                                       {
        Hz frequency = std::get<1>(p);
        auto propagationSpeed = radioMedium->getPropagation()->getPropagationSpeed();
        auto pathLoss = radioMedium->getPathLoss()->computePathLoss(propagationSpeed, frequency, distance);
        auto obstacleLoss = radioMedium->getObstacleLoss() ? radioMedium->getObstacleLoss()->computeObstacleLoss(frequency, transmissionPosition, receptionPosition) : 1;
        double gain = transmitterAntennaGain * receiverAntennaGain * pathLoss * obstacleLoss;
        ASSERT(!std::isnan(gain));
        if (gain > 1.0) {
            EV_STATICCONTEXT;
            EV_WARN << "Signal power attenuation is zero.\n";
            gain = 1.0;
        }
        return gain;
    }

isFinite()

virtual bool inet::physicallayer::FrequencyDependentAttenuationFunction::isFinite ( const Interval< simsec, Hz > &  i ) const

inlineoverridevirtual

{ return true; }

printStructure()

virtual void inet::physicallayer::FrequencyDependentAttenuationFunction::printStructure ( std::ostream &  os, int  level = 0  ) const

inlineoverridevirtual

Prints the internal data structure of this function in a human readable form to the provided stream.

Reimplemented from inet::math::FunctionBase< double, Domain< simsec, Hz > >.

                                                                              {
        os << "(FrequencyDependentAttenuation" << EV_FIELD(distance) << EV_FIELD(transmitterAntennaGain) << EV_FIELD(receiverAntennaGain);
        os << "\n" << std::string(level + 2, ' ');
        os << "(" << *radioMedium->getPathLoss() << ")";
        os << "\n" << std::string(level + 2, ' ');
        os << "(" << *radioMedium->getObstacleLoss() << "))";
    }

Member Data Documentation

distance

const m inet::physicallayer::FrequencyDependentAttenuationFunction::distance

protected

radioMedium

const IRadioMedium* inet::physicallayer::FrequencyDependentAttenuationFunction::radioMedium = nullptr

protected

receiverAntennaGain

const double inet::physicallayer::FrequencyDependentAttenuationFunction::receiverAntennaGain

protected

receptionPosition

const Coord inet::physicallayer::FrequencyDependentAttenuationFunction::receptionPosition

protected

transmissionPosition

const Coord inet::physicallayer::FrequencyDependentAttenuationFunction::transmissionPosition

protected

transmitterAntennaGain

const double inet::physicallayer::FrequencyDependentAttenuationFunction::transmitterAntennaGain

protected

---

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

• PowerFunctions.h