PathLossModel.h Source File¶

Simu5G: PathLossModel.h Source File
Simu5G
//
//                  Simu5G
//
// Copyright (C) 2012-2021 Giovanni Nardini, Giovanni Stea, Antonio Virdis et al. (University of Pisa)
// Copyright (C) 2022-2026 Giovanni Nardini, Giovanni Stea et al. (University of Pisa)
//
// This file is part of a software released under the license included in file
// "license.pdf". Please read LICENSE and README files before using it.
// The above files and the present reference are part of the software itself,
// and cannot be removed from it.
//
 
#ifndef STACK_PHY_CHANNELMODEL_PATHLOSSMODEL_H_
#define STACK_PHY_CHANNELMODEL_PATHLOSSMODEL_H_
 
#include "simu5g/common/LteCommon.h"
 
namespace simu5g {
 
using namespace omnetpp;
class PathLossModel
{
  protected:
    cComponent *owner_ = nullptr;  // RNG + parameter context
 
    DeploymentScenario scenario_ = UNKNOWN_SCENARIO;
    double hNodeB_ = 0;
    double hUe_ = 0;
    double hBuilding_ = 0;
    double wStreet_ = 0;
    bool inside_building_ = false;
    double inside_distance_ = 0;
    double carrierFrequencyHz_ = 0;
    double carrierFrequencyGHz_ = 0;
    double log10CarrierFrequencyGHz_ = 0;
    bool tolerateMaxDistViolation_ = false;
 
    /*
     * Propagation velocity in free space, as the breakpoint-distance notes of
     * all three reports define it. This is the rounded 3.0e8 m/s they write,
     * not the exact speed of light: the breakpoint distance appears in the
     * beyond-breakpoint path-loss formulas themselves and not only in the
     * branch condition, so the two choices differ by about 0.005 dB on every
     * LOS link past a breakpoint.
     */
    static constexpr double PROPAGATION_VELOCITY = 3.0e8;
 
  public:
    virtual ~PathLossModel() {}
 
    /*
     * Copy the deployment-scenario parameters the formulas need. Parameter
     * ownership stays with the owning channel model; this only receives the
     * values it has already read from its NED parameters.
     */
    virtual void initialize(cComponent *owner, DeploymentScenario scenario,
            double hNodeB, double hUe, double hBuilding, double wStreet,
            bool insideBuilding, double insideDistance,
            double carrierFrequencyHz, double carrierFrequencyGHz, double log10CarrierFrequencyGHz,
            bool tolerateMaxDistViolation);
 
    /*
     * Compute the path-loss attenuation according to the selected scenario.
     * A concrete model that needs only one of the two distances ignores the
     * other.
     */
    virtual double computePathLoss(double d3D, double d2D, bool los) = 0;
 
    /*
     * Compute the LOS probability according to the selected scenario.
     * Returns the probability p; the caller draws against it and stores the
     * outcome.
     */
    virtual double computeLosProbability(double d3D, double d2D) = 0;
 
    /*
     * Compute the standard deviation of the log-normal shadowing according
     * to the selected scenario and the LOS state of the link.
     */
    virtual double getShadowingStdDev(double d3D, double d2D, bool losState) = 0;
 
    /*
     * Compute the attenuation caused by the antenna pattern for a given
     * reception direction.
     */
    virtual double computeAngularAttenuation(double hAngle, double vAngle) = 0;
};
 
} //namespace
 
#endif