A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::ThreeGppUmaPropagationLossModel Class Reference

Implements the pathloss model defined in 3GPP TR 38.901, Table 7.4.1-1 for the UMa scenario. More...

#include "three-gpp-propagation-loss-model.h"

+ Inheritance diagram for ns3::ThreeGppUmaPropagationLossModel:
+ Collaboration diagram for ns3::ThreeGppUmaPropagationLossModel:

Public Member Functions

 ThreeGppUmaPropagationLossModel ()
 Constructor.
 
 ThreeGppUmaPropagationLossModel (const ThreeGppUmaPropagationLossModel &)=delete
 
 ~ThreeGppUmaPropagationLossModel () override
 Destructor.
 
ThreeGppUmaPropagationLossModeloperator= (const ThreeGppUmaPropagationLossModel &)=delete
 
- Public Member Functions inherited from ns3::ThreeGppPropagationLossModel
 ThreeGppPropagationLossModel ()
 Constructor.
 
 ThreeGppPropagationLossModel (const ThreeGppPropagationLossModel &)=delete
 
 ~ThreeGppPropagationLossModel () override
 Destructor.
 
Ptr< ChannelConditionModelGetChannelConditionModel () const
 Returns the associated channel condition model.
 
double GetFrequency () const
 Return the current central frequency.
 
bool IsO2iLowPenetrationLoss (Ptr< const ChannelCondition > cond) const
 Return true if the O2I Building Penetration loss corresponds to a low loss condition.
 
ThreeGppPropagationLossModeloperator= (const ThreeGppPropagationLossModel &)=delete
 
void SetChannelConditionModel (Ptr< ChannelConditionModel > model)
 Set the channel condition model used to determine the channel state (e.g., the LOS/NLOS condition)
 
void SetFrequency (double f)
 Set the central frequency of the model.
 
- Public Member Functions inherited from ns3::PropagationLossModel
 PropagationLossModel ()
 
 PropagationLossModel (const PropagationLossModel &)=delete
 
 ~PropagationLossModel () 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'.
 
double CalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 Returns the Rx Power taking into account all the PropagationLossModel(s) chained to the current one.
 
Ptr< PropagationLossModelGetNext ()
 Gets the next PropagationLossModel in the chain of loss models that act on the signal.
 
PropagationLossModeloperator= (const PropagationLossModel &)=delete
 
void SetNext (Ptr< PropagationLossModel > next)
 Enables a chain of loss models to act on the signal.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

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

Private Member Functions

int64_t DoAssignStreams (int64_t stream) override
 Assign a fixed random variable stream number to the random variables used by this model.
 
double GetBpDistance (double hUt, double hBs, double distance2D) const
 Computes the breakpoint distance.
 
double GetLossLos (Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
 Computes the pathloss between a and b considering that the line of sight is not obstructed.
 
double GetLossNlos (Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
 Computes the pathloss between a and b considering that the line of sight is obstructed.
 
double GetO2iDistance2dIn () const override
 Returns the minimum of the two independently generated distances according to the uniform distribution between the minimum and the maximum value depending on the specific 3GPP scenario (UMa, UMi-Street Canyon, RMa), i.e., between 0 and 25 m for UMa and UMi-Street Canyon, and between 0 and 10 m for RMa.
 
double GetShadowingCorrelationDistance (ChannelCondition::LosConditionValue cond) const override
 Returns the shadow fading correlation distance.
 
double GetShadowingStd (Ptr< MobilityModel > a, Ptr< MobilityModel > b, ChannelCondition::LosConditionValue cond) const override
 Returns the shadow fading standard deviation.
 

Private Attributes

Ptr< UniformRandomVariablem_uniformVar
 a uniform random variable used for the computation of the breakpoint distance
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ThreeGppPropagationLossModel
void DoDispose () override
 Destructor implementation.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 
- Static Protected Member Functions inherited from ns3::ThreeGppPropagationLossModel
static double Calculate2dDistance (Vector a, Vector b)
 Computes the 2D distance between two 3D vectors.
 
- Protected Attributes inherited from ns3::ThreeGppPropagationLossModel
bool m_buildingPenLossesEnabled
 enable/disable building penetration losses
 
Ptr< ChannelConditionModelm_channelConditionModel
 pointer to the channel condition model
 
bool m_enforceRanges
 strictly enforce TR 38.901 parameter ranges
 
double m_frequency
 operating frequency in Hz
 
Ptr< NormalRandomVariablem_normalO2iHighLossVar
 a normal random variable for the calculation of 02i high loss, see TR38.901 Table 7.4.3-2
 
Ptr< NormalRandomVariablem_normalO2iLowLossVar
 a normal random variable for the calculation of 02i low loss, see TR38.901 Table 7.4.3-2
 
Ptr< NormalRandomVariablem_normRandomVariable
 normal random variable
 
std::unordered_map< uint32_t, O2iLossMapItemm_o2iLossMap
 map to store the o2i Loss values
 
Ptr< UniformRandomVariablem_randomO2iVar1
 a uniform random variable for the calculation of the indoor loss, see TR38.901 Table 7.4.3-2
 
Ptr< UniformRandomVariablem_randomO2iVar2
 a uniform random variable for the calculation of the indoor loss, see TR38.901 Table 7.4.3-2
 
bool m_shadowingEnabled
 enable/disable shadowing
 
std::unordered_map< uint32_t, ShadowingMapItemm_shadowingMap
 map to store the shadowing values
 

Detailed Description

Implements the pathloss model defined in 3GPP TR 38.901, Table 7.4.1-1 for the UMa scenario.

Config Paths

ns3::ThreeGppUmaPropagationLossModel is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::lrwpan::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::lrwpan::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppUmaPropagationLossModel"

No Attributes are defined for this type.

Attributes defined in parent class ns3::ThreeGppPropagationLossModel

  • BuildingPenetrationLossesEnabled: Enable/disable Building Penetration Losses.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • ChannelConditionModel: Pointer to the channel condition model.
  • EnforceParameterRanges: Whether to strictly enforce TR38.901 applicability ranges
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • Frequency: The centre frequency in Hz.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 5e+08
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • ShadowingEnabled: Enable/disable shadowing.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
    • Support level: SUPPORTED

No TraceSources are defined for this type.
Group: Propagation

Size of this type is 248 bytes (on a 64-bit architecture).

Definition at line 422 of file three-gpp-propagation-loss-model.h.

Constructor & Destructor Documentation

◆ ThreeGppUmaPropagationLossModel() [1/2]

ns3::ThreeGppUmaPropagationLossModel::ThreeGppUmaPropagationLossModel ( )

Constructor.

Definition at line 982 of file three-gpp-propagation-loss-model.cc.

References ns3::CreateObject(), ns3::ThreeGppPropagationLossModel::m_channelConditionModel, m_uniformVar, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ ~ThreeGppUmaPropagationLossModel()

ns3::ThreeGppUmaPropagationLossModel::~ThreeGppUmaPropagationLossModel ( )
override

Destructor.

Definition at line 991 of file three-gpp-propagation-loss-model.cc.

References NS_LOG_FUNCTION.

◆ ThreeGppUmaPropagationLossModel() [2/2]

ns3::ThreeGppUmaPropagationLossModel::ThreeGppUmaPropagationLossModel ( const ThreeGppUmaPropagationLossModel & )
delete

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::ThreeGppUmaPropagationLossModel::DoAssignStreams ( int64_t stream)
overrideprivatevirtual

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

Reimplemented from ns3::ThreeGppPropagationLossModel.

Definition at line 1195 of file three-gpp-propagation-loss-model.cc.

References ns3::ThreeGppPropagationLossModel::m_normRandomVariable, m_uniformVar, and NS_LOG_FUNCTION.

◆ GetBpDistance()

double ns3::ThreeGppUmaPropagationLossModel::GetBpDistance ( double hUt,
double hBs,
double distance2D ) const
private

Computes the breakpoint distance.

Parameters
hUtheight of the UT in meters
hBsheight of the BS in meters
distance2Ddistance between the two nodes in meters
Returns
the breakpoint distance in meters

Definition at line 997 of file three-gpp-propagation-loss-model.cc.

References ns3::ThreeGppPropagationLossModel::m_frequency, m_uniformVar, and NS_LOG_FUNCTION.

Referenced by GetLossLos().

+ Here is the caller graph for this function:

◆ GetLossLos()

double ns3::ThreeGppUmaPropagationLossModel::GetLossLos ( Ptr< MobilityModel > a,
Ptr< MobilityModel > b ) const
overrideprivatevirtual

Computes the pathloss between a and b considering that the line of sight is not obstructed.

Parameters
atx mobility model
brx mobility model
Returns
pathloss value in dB

Implements ns3::ThreeGppPropagationLossModel.

Definition at line 1035 of file three-gpp-propagation-loss-model.cc.

References GetBpDistance(), ns3::ThreeGppPropagationLossModel::m_enforceRanges, ns3::ThreeGppPropagationLossModel::m_frequency, NS_ABORT_MSG_IF, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by GetLossNlos().

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

◆ GetLossNlos()

double ns3::ThreeGppUmaPropagationLossModel::GetLossNlos ( Ptr< MobilityModel > a,
Ptr< MobilityModel > b ) const
overrideprivatevirtual

Computes the pathloss between a and b considering that the line of sight is obstructed.

Parameters
atx mobility model
brx mobility model
Returns
pathloss value in dB

Implements ns3::ThreeGppPropagationLossModel.

Definition at line 1102 of file three-gpp-propagation-loss-model.cc.

References GetLossLos(), ns3::ThreeGppPropagationLossModel::m_enforceRanges, ns3::ThreeGppPropagationLossModel::m_frequency, NS_ABORT_MSG_IF, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_WARN.

+ Here is the call graph for this function:

◆ GetO2iDistance2dIn()

double ns3::ThreeGppUmaPropagationLossModel::GetO2iDistance2dIn ( ) const
overrideprivatevirtual

Returns the minimum of the two independently generated distances according to the uniform distribution between the minimum and the maximum value depending on the specific 3GPP scenario (UMa, UMi-Street Canyon, RMa), i.e., between 0 and 25 m for UMa and UMi-Street Canyon, and between 0 and 10 m for RMa.

According to 3GPP TR 38.901 this 2D−in distance shall be UT-specifically generated. 2D−in distance is used for the O2I penetration losses calculation according to 3GPP TR 38.901 7.4.3. See GetO2iLowPenetrationLoss/GetO2iHighPenetrationLoss functions.

Returns
Returns 02i 2D distance (in meters) used to calculate low/high losses.

Implements ns3::ThreeGppPropagationLossModel.

Definition at line 1094 of file three-gpp-propagation-loss-model.cc.

References ns3::ThreeGppPropagationLossModel::m_randomO2iVar1, and ns3::ThreeGppPropagationLossModel::m_randomO2iVar2.

◆ GetShadowingCorrelationDistance()

double ns3::ThreeGppUmaPropagationLossModel::GetShadowingCorrelationDistance ( ChannelCondition::LosConditionValue cond) const
overrideprivatevirtual

Returns the shadow fading correlation distance.

Parameters
condthe LOS/NLOS channel condition
Returns
shadowing correlation distance in meters

Implements ns3::ThreeGppPropagationLossModel.

Definition at line 1171 of file three-gpp-propagation-loss-model.cc.

References ns3::ChannelCondition::LOS, ns3::ChannelCondition::NLOS, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

◆ GetShadowingStd()

double ns3::ThreeGppUmaPropagationLossModel::GetShadowingStd ( Ptr< MobilityModel > a,
Ptr< MobilityModel > b,
ChannelCondition::LosConditionValue cond ) const
overrideprivatevirtual

Returns the shadow fading standard deviation.

Parameters
atx mobility model
brx mobility model
condthe LOS/NLOS channel condition
Returns
shadowing std in dB

Implements ns3::ThreeGppPropagationLossModel.

Definition at line 1147 of file three-gpp-propagation-loss-model.cc.

References ns3::ChannelCondition::LOS, ns3::ChannelCondition::NLOS, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::ThreeGppUmaPropagationLossModel::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 973 of file three-gpp-propagation-loss-model.cc.

References ns3::TypeId::SetParent().

Referenced by BuildingsPenetrationLossesTestCase::DoRun().

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

◆ operator=()

ThreeGppUmaPropagationLossModel & ns3::ThreeGppUmaPropagationLossModel::operator= ( const ThreeGppUmaPropagationLossModel & )
delete

Member Data Documentation

◆ m_uniformVar

Ptr<UniformRandomVariable> ns3::ThreeGppUmaPropagationLossModel::m_uniformVar
private

a uniform random variable used for the computation of the breakpoint distance

Definition at line 507 of file three-gpp-propagation-loss-model.h.

Referenced by ThreeGppUmaPropagationLossModel(), DoAssignStreams(), and GetBpDistance().


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