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

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

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

+ Inheritance diagram for ns3::ThreeGppUmiStreetCanyonPropagationLossModel:
+ Collaboration diagram for ns3::ThreeGppUmiStreetCanyonPropagationLossModel:

Public Member Functions

 ThreeGppUmiStreetCanyonPropagationLossModel ()
 Constructor. More...
 
 ThreeGppUmiStreetCanyonPropagationLossModel (const ThreeGppUmiStreetCanyonPropagationLossModel &)=delete
 Copy constructor. More...
 
virtual ~ThreeGppUmiStreetCanyonPropagationLossModel () override
 Destructor. More...
 
ThreeGppUmiStreetCanyonPropagationLossModeloperator= (const ThreeGppUmiStreetCanyonPropagationLossModel &)=delete
 Copy constructor. More...
 
- Public Member Functions inherited from ns3::ThreeGppPropagationLossModel
 ThreeGppPropagationLossModel ()
 Constructor. More...
 
 ThreeGppPropagationLossModel (const ThreeGppPropagationLossModel &)=delete
 Copy constructor. More...
 
virtual ~ThreeGppPropagationLossModel () override
 Destructor. More...
 
Ptr< ChannelConditionModelGetChannelConditionModel (void) const
 Returns the associated channel condition model. More...
 
double GetFrequency (void) const
 Return the current central frequency. More...
 
ThreeGppPropagationLossModeloperator= (const ThreeGppPropagationLossModel &)=delete
 Copy constructor. More...
 
void SetChannelConditionModel (Ptr< ChannelConditionModel > model)
 Set the channel condition model used to determine the channel state (e.g., the LOS/NLOS condition) More...
 
void SetFrequency (double f)
 Set the central frequency of the model. More...
 
- Public Member Functions inherited from ns3::PropagationLossModel
 PropagationLossModel ()
 
virtual ~PropagationLossModel ()
 
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...
 
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. More...
 
Ptr< PropagationLossModelGetNext ()
 Gets the next PropagationLossModel in the chain of loss models that act on the signal. More...
 
void SetNext (Ptr< PropagationLossModel > next)
 Enables a chain of loss models to act on the signal. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated 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 () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) 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 erros. 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 (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ThreeGppPropagationLossModel
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::PropagationLossModel
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

double GetBpDistance (double hUt, double hBs, double distance2D) const
 Computes the breakpoint distance. More...
 
double GetLossLos (double distance2D, double distance3D, double hUt, double hBs) const override
 Computes the pathloss between a and b considering that the line of sight is not obstructed. More...
 
double GetLossNlos (double distance2D, double distance3D, double hUt, double hBs) const override
 Computes the pathloss between a and b considering that the line of sight is obstructed. More...
 
virtual double GetShadowingCorrelationDistance (ChannelCondition::LosConditionValue cond) const override
 Returns the shadow fading correlation distance. More...
 
virtual double GetShadowingStd (Ptr< MobilityModel > a, Ptr< MobilityModel > b, ChannelCondition::LosConditionValue cond) const override
 Returns the shadow fading standard deviation. More...
 
std::pair< double, double > GetUtAndBsHeights (double za, double zb) const override
 Determines hUT and hBS. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ThreeGppPropagationLossModel
virtual void DoDispose () override
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 
- Static Protected Member Functions inherited from ns3::ThreeGppPropagationLossModel
static double Calculate2dDistance (Vector a, Vector b)
 Computes the 2D distance between two 3D vectors. More...
 
- Protected Attributes inherited from ns3::ThreeGppPropagationLossModel
Ptr< ChannelConditionModelm_channelConditionModel
 pointer to the channel condition model More...
 
double m_frequency
 operating frequency in Hz More...
 
Ptr< NormalRandomVariablem_normRandomVariable
 normal random variable More...
 
bool m_shadowingEnabled
 enable/disable shadowing More...
 
std::unordered_map< uint32_t, ShadowingMapItemm_shadowingMap
 map to store the shadowing values More...
 

Detailed Description

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


Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppPropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ThreeGppUmiStreetCanyonPropagationLossModel"

No Attributes are defined for this type.

Attributes defined in parent class ns3::ThreeGppPropagationLossModel

  • 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: construct write read
  • ShadowingEnabled: Enable/disable shadowing.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read
  • ChannelConditionModel: Pointer to the channel condition model.

No TraceSources are defined for this type.
Size of this type is 128 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ ThreeGppUmiStreetCanyonPropagationLossModel() [1/2]

ns3::ThreeGppUmiStreetCanyonPropagationLossModel::ThreeGppUmiStreetCanyonPropagationLossModel ( )

◆ ~ThreeGppUmiStreetCanyonPropagationLossModel()

ns3::ThreeGppUmiStreetCanyonPropagationLossModel::~ThreeGppUmiStreetCanyonPropagationLossModel ( )
overridevirtual

Destructor.

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

References NS_LOG_FUNCTION.

◆ ThreeGppUmiStreetCanyonPropagationLossModel() [2/2]

ns3::ThreeGppUmiStreetCanyonPropagationLossModel::ThreeGppUmiStreetCanyonPropagationLossModel ( const ThreeGppUmiStreetCanyonPropagationLossModel )
delete

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

◆ GetBpDistance()

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

Computes the breakpoint distance.

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

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

References ns3::M_C, ns3::ThreeGppPropagationLossModel::m_frequency, NS_LOG_FUNCTION, and NS_UNUSED.

Referenced by GetLossLos().

+ Here is the caller graph for this function:

◆ GetLossLos()

double ns3::ThreeGppUmiStreetCanyonPropagationLossModel::GetLossLos ( double  distance2D,
double  distance3D,
double  hUt,
double  hBs 
) const
overrideprivatevirtual

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

Parameters
distance2Dthe 2D distance between tx and rx in meters
distance3Dthe 3D distance between tx and rx in meters
hUtthe height of the UT in meters
hBsthe height of the BS in meters
Returns
pathloss value in dB

Implements ns3::ThreeGppPropagationLossModel.

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

References GetBpDistance(), ns3::ThreeGppPropagationLossModel::m_frequency, 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::ThreeGppUmiStreetCanyonPropagationLossModel::GetLossNlos ( double  distance2D,
double  distance3D,
double  hUt,
double  hBs 
) const
overrideprivatevirtual

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

Parameters
distance2Dthe 2D distance between tx and rx in meters
distance3Dthe 3D distance between tx and rx in meters
hUtthe height of the UT in meters
hBsthe height of the BS in meters
Returns
pathloss value in dB

Implements ns3::ThreeGppPropagationLossModel.

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

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

+ Here is the call graph for this function:

◆ GetShadowingCorrelationDistance()

double ns3::ThreeGppUmiStreetCanyonPropagationLossModel::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 895 of file three-gpp-propagation-loss-model.cc.

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

◆ GetShadowingStd()

double ns3::ThreeGppUmiStreetCanyonPropagationLossModel::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 871 of file three-gpp-propagation-loss-model.cc.

References NS_FATAL_ERROR, NS_LOG_FUNCTION, and NS_UNUSED.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetUtAndBsHeights()

std::pair< double, double > ns3::ThreeGppUmiStreetCanyonPropagationLossModel::GetUtAndBsHeights ( double  za,
double  zb 
) const
overrideprivatevirtual

Determines hUT and hBS.

Overrides the default implementation.

Parameters
zathe height of the first node in meters
zbthe height of the second node in meters
Returns
std::pair, the first element is hUt and the second is hBs

Reimplemented from ns3::ThreeGppPropagationLossModel.

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

References max, min, and NS_LOG_FUNCTION.

◆ operator=()

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

Copy constructor.

Defined and unimplemented to avoid misuse

Returns
the ThreeGppUmiStreetCanyonPropagationLossModel instance

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