A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::TwoRayGroundPropagationLossModel Class Reference

a Two-Ray Ground propagation loss model ported from NS2 More...

#include "propagation-loss-model.h"

+ Inheritance diagram for ns3::TwoRayGroundPropagationLossModel:

Public Member Functions

 TwoRayGroundPropagationLossModel ()
 
double GetFrequency (void) const
 
double GetMinDistance (void) const
 
double GetSystemLoss (void) const
 
void SetFrequency (double frequency)
 
void SetHeightAboveZ (double heightAboveZ)
 
void SetMinDistance (double minDistance)
 
void SetSystemLoss (double systemLoss)
 
- 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...
 
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::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

 TwoRayGroundPropagationLossModel (const TwoRayGroundPropagationLossModel &)
 Copy constructor. More...
 
double DbmFromW (double w) const
 Transforms a Watt value to Dbm. More...
 
double DbmToW (double dbm) const
 Transforms a Dbm value to Watt. More...
 
virtual int64_t DoAssignStreams (int64_t stream)
 Subclasses must implement this; those not using random variables can return zero. More...
 
virtual double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 Returns the Rx Power taking into account only the particular PropagationLossModel. More...
 
TwoRayGroundPropagationLossModeloperator= (const TwoRayGroundPropagationLossModel &)
 Copy constructor. More...
 

Private Attributes

double m_frequency
 the carrier frequency More...
 
double m_heightAboveZ
 antenna height above the node's Z coordinate More...
 
double m_lambda
 the carrier wavelength More...
 
double m_minDistance
 minimum distance for the model More...
 
double m_systemLoss
 the system 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 Two-Ray Ground propagation loss model ported from NS2


Two-ray ground reflection model.

$ Pr = \frac{P_t * G_t * G_r * (H_t^2 * H_r^2)}{d^4 * L} $

The original equation in Rappaport's book assumes L = 1. To be consistent with the free space equation, L is added here.

Ht and Hr are set at the respective nodes z coordinate plus a model parameter set via SetHeightAboveZ.

The two-ray model does not give a good result for short distances, due to the oscillation caused by constructive and destructive combination of the two rays. Instead the Friis free-space model is used for small distances.

The crossover distance, below which Friis is used, is calculated as follows:

$ dCross = \frac{(4 * \pi * H_t * H_r)}{\lambda} $

In the implementation, $ \lambda $ is calculated as $ \frac{C}{f} $, where $ C = 299792458$ m/s is the speed of light in vacuum, and $ f $ is the frequency in Hz which can be configured by the user via the Frequency attribute.

Config Paths

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

Attributes

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

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

Constructor & Destructor Documentation

◆ TwoRayGroundPropagationLossModel() [1/2]

ns3::TwoRayGroundPropagationLossModel::TwoRayGroundPropagationLossModel ( )

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

◆ TwoRayGroundPropagationLossModel() [2/2]

ns3::TwoRayGroundPropagationLossModel::TwoRayGroundPropagationLossModel ( const TwoRayGroundPropagationLossModel )
private

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

◆ DbmFromW()

double ns3::TwoRayGroundPropagationLossModel::DbmFromW ( double  w) const
private

Transforms a Watt value to Dbm.

Parameters
wthe Watt value
Returns
the Dbm

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

◆ DbmToW()

double ns3::TwoRayGroundPropagationLossModel::DbmToW ( double  dbm) const
private

Transforms a Dbm value to Watt.

Parameters
dbmthe Dbm value
Returns
the Watts

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

◆ DoAssignStreams()

int64_t ns3::TwoRayGroundPropagationLossModel::DoAssignStreams ( int64_t  stream)
privatevirtual

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

Implements ns3::PropagationLossModel.

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

◆ DoCalcRxPower()

double ns3::TwoRayGroundPropagationLossModel::DoCalcRxPower ( double  txPowerDbm,
Ptr< MobilityModel a,
Ptr< MobilityModel b 
) const
privatevirtual

Returns the Rx Power taking into account only the particular 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)

Implements ns3::PropagationLossModel.

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

References ns3::MobilityModel::GetDistanceFrom(), ns3::MobilityModel::GetPosition(), m_heightAboveZ, m_lambda, m_minDistance, m_systemLoss, and NS_LOG_DEBUG.

◆ GetFrequency()

double ns3::TwoRayGroundPropagationLossModel::GetFrequency ( void  ) const
Returns
the current frequency (Hz)

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

References m_frequency.

Referenced by GetTypeId().

◆ GetMinDistance()

double ns3::TwoRayGroundPropagationLossModel::GetMinDistance ( void  ) const
Returns
the minimum distance.

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

References m_minDistance.

Referenced by GetTypeId().

◆ GetSystemLoss()

double ns3::TwoRayGroundPropagationLossModel::GetSystemLoss ( void  ) const
Returns
the current system loss (dimension-less)

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

References m_systemLoss.

◆ GetTypeId()

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

◆ operator=()

TwoRayGroundPropagationLossModel& ns3::TwoRayGroundPropagationLossModel::operator= ( const TwoRayGroundPropagationLossModel )
private

Copy constructor.

Defined and unimplemented to avoid misuse

Returns

◆ SetFrequency()

void ns3::TwoRayGroundPropagationLossModel::SetFrequency ( double  frequency)
Parameters
frequency(Hz)

Set the carrier frequency used in the TwoRayGround model calculation.

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

References m_frequency, and m_lambda.

Referenced by GetTypeId().

◆ SetHeightAboveZ()

void ns3::TwoRayGroundPropagationLossModel::SetHeightAboveZ ( double  heightAboveZ)
Parameters
heightAboveZthe model antenna height above the node's Z coordinate

Set the model antenna height above the node's Z coordinate

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

References m_heightAboveZ.

◆ SetMinDistance()

void ns3::TwoRayGroundPropagationLossModel::SetMinDistance ( double  minDistance)
Parameters
minDistancethe minimum distance

Below this distance, the txpower is returned unmodified as the rxpower.

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

References m_minDistance.

Referenced by GetTypeId().

◆ SetSystemLoss()

void ns3::TwoRayGroundPropagationLossModel::SetSystemLoss ( double  systemLoss)
Parameters
systemLoss(dimension-less)

Set the system loss used by the TwoRayGround propagation model.

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

References m_systemLoss.

Member Data Documentation

◆ m_frequency

double ns3::TwoRayGroundPropagationLossModel::m_frequency
private

the carrier frequency

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

Referenced by GetFrequency(), and SetFrequency().

◆ m_heightAboveZ

double ns3::TwoRayGroundPropagationLossModel::m_heightAboveZ
private

antenna height above the node's Z coordinate

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

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

◆ m_lambda

double ns3::TwoRayGroundPropagationLossModel::m_lambda
private

the carrier wavelength

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

Referenced by DoCalcRxPower(), and SetFrequency().

◆ m_minDistance

double ns3::TwoRayGroundPropagationLossModel::m_minDistance
private

minimum distance for the model

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

Referenced by DoCalcRxPower(), GetMinDistance(), and SetMinDistance().

◆ m_systemLoss

double ns3::TwoRayGroundPropagationLossModel::m_systemLoss
private

the system loss

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

Referenced by DoCalcRxPower(), GetSystemLoss(), GetTypeId(), and SetSystemLoss().


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