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

a log distance propagation model. More...

#include "propagation-loss-model.h"

+ Inheritance diagram for ns3::LogDistancePropagationLossModel:
+ Collaboration diagram for ns3::LogDistancePropagationLossModel:

Public Member Functions

 LogDistancePropagationLossModel ()
 
 LogDistancePropagationLossModel (const LogDistancePropagationLossModel &)=delete
 
double GetPathLossExponent (void) const
 
LogDistancePropagationLossModeloperator= (const LogDistancePropagationLossModel &)=delete
 
void SetPathLossExponent (double n)
 
void SetReference (double referenceDistance, double referenceLoss)
 Set the reference path loss at a given distance. More...
 
- Public Member Functions inherited from ns3::PropagationLossModel
 PropagationLossModel ()
 
 PropagationLossModel (const PropagationLossModel &)=delete
 
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...
 
PropagationLossModeloperator= (const PropagationLossModel &)=delete
 
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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::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 (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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::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

int64_t DoAssignStreams (int64_t stream) override
 Subclasses must implement this; those not using random variables can return zero. More...
 
double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
 PropagationLossModel. More...
 

Static Private Member Functions

static Ptr< PropagationLossModelCreateDefaultReference (void)
 Creates a default reference loss model. More...
 

Private Attributes

double m_exponent
 model exponent More...
 
double m_referenceDistance
 reference distance More...
 
double m_referenceLoss
 reference loss More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. 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...
 

Detailed Description

a log distance propagation model.

This model calculates the reception power with a so-called log-distance propagation model: $ L = L_0 + 10 n log_{10}(\frac{d}{d_0})$

where:

  • $ n $ : the path loss distance exponent
  • $ d_0 $ : reference distance (m)
  • $ L_0 $ : path loss at reference distance (dB)
  • $ d $ : distance (m)
  • $ L $ : path loss (dB)

When the path loss is requested at a distance smaller than the reference distance, the tx power is returned.

Config Paths

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

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

Attributes

  • Exponent: The exponent of the Path Loss propagation model
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 3
    • Flags: construct write read
  • ReferenceDistance: The distance at which the reference loss is calculated (m)
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: construct write read
  • ReferenceLoss: The reference loss at reference distance (dB). (Default is Friis at 1m with 5.15 GHz)
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 46.6777
    • Flags: construct write read

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

Definition at line 452 of file propagation-loss-model.h.

Constructor & Destructor Documentation

◆ LogDistancePropagationLossModel() [1/2]

ns3::LogDistancePropagationLossModel::LogDistancePropagationLossModel ( )

Definition at line 485 of file propagation-loss-model.cc.

◆ LogDistancePropagationLossModel() [2/2]

ns3::LogDistancePropagationLossModel::LogDistancePropagationLossModel ( const LogDistancePropagationLossModel )
delete

Member Function Documentation

◆ CreateDefaultReference()

static Ptr<PropagationLossModel> ns3::LogDistancePropagationLossModel::CreateDefaultReference ( void  )
staticprivate

Creates a default reference loss model.

Returns
a default reference loss model

◆ DoAssignStreams()

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

Subclasses must implement this; those not using random variables can return zero.

Parameters
streamthe stream index offset start
Returns
the number of stream indices assigned by this model

Implements ns3::PropagationLossModel.

Definition at line 538 of file propagation-loss-model.cc.

◆ DoCalcRxPower()

double ns3::LogDistancePropagationLossModel::DoCalcRxPower ( double  txPowerDbm,
Ptr< MobilityModel a,
Ptr< MobilityModel b 
) const
overrideprivatevirtual

PropagationLossModel.

Parameters
txPowerDbmcurrent transmission power (in dBm)
athe mobility model of the source
bthe mobility model of the destination
Returns
the reception power after adding/multiplying propagation loss (in dBm)

The formula is: rx = 10 * log (Pr0(tx)) - n * 10 * log (d/d0)

Pr0: rx power at reference distance d0 (W) d0: reference distance: 1.0 (m) d: distance (m) tx: tx power (dB) rx: dB

Which, in our case is:

rx = rx0(tx) - 10 * n * log (d/d0)

Implements ns3::PropagationLossModel.

Definition at line 507 of file propagation-loss-model.cc.

References ns3::MobilityModel::GetDistanceFrom(), m_exponent, m_referenceDistance, m_referenceLoss, and NS_LOG_DEBUG.

+ Here is the call graph for this function:

◆ GetPathLossExponent()

double ns3::LogDistancePropagationLossModel::GetPathLossExponent ( void  ) const
Returns
the current path loss exponent.

Definition at line 501 of file propagation-loss-model.cc.

References m_exponent.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 459 of file propagation-loss-model.cc.

References m_exponent, m_referenceDistance, m_referenceLoss, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ operator=()

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

◆ SetPathLossExponent()

void ns3::LogDistancePropagationLossModel::SetPathLossExponent ( double  n)
Parameters
nthe path loss exponent. Set the path loss exponent.

Definition at line 490 of file propagation-loss-model.cc.

References m_exponent, and sample-rng-plot::n.

Referenced by LrWpanCcaTestCase::DoRun().

+ Here is the caller graph for this function:

◆ SetReference()

void ns3::LogDistancePropagationLossModel::SetReference ( double  referenceDistance,
double  referenceLoss 
)

Set the reference path loss at a given distance.

Parameters
referenceDistancereference distance
referenceLossreference path loss

Definition at line 495 of file propagation-loss-model.cc.

References m_referenceDistance, and m_referenceLoss.

Referenced by LrWpanCcaTestCase::DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_exponent

double ns3::LogDistancePropagationLossModel::m_exponent
private

model exponent

Definition at line 496 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), GetPathLossExponent(), GetTypeId(), and SetPathLossExponent().

◆ m_referenceDistance

double ns3::LogDistancePropagationLossModel::m_referenceDistance
private

reference distance

Definition at line 497 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), GetTypeId(), and SetReference().

◆ m_referenceLoss

double ns3::LogDistancePropagationLossModel::m_referenceLoss
private

reference loss

Definition at line 498 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), GetTypeId(), and SetReference().


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