a Two-Ray Ground propagation loss model ported from NS2 More...
#include "propagation-loss-model.h"
Public Member Functions | |
TwoRayGroundPropagationLossModel () | |
TwoRayGroundPropagationLossModel (const TwoRayGroundPropagationLossModel &)=delete | |
double | GetFrequency () const |
double | GetMinDistance () const |
double | GetSystemLoss () const |
TwoRayGroundPropagationLossModel & | operator= (const TwoRayGroundPropagationLossModel &)=delete |
void | SetFrequency (double frequency) |
void | SetHeightAboveZ (double heightAboveZ) |
void | SetMinDistance (double minDistance) |
void | SetSystemLoss (double systemLoss) |
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< PropagationLossModel > | GetNext () |
Gets the next PropagationLossModel in the chain of loss models that act on the signal. | |
PropagationLossModel & | operator= (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< Object > | GetObject () 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< Object > | GetObject (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. | |
SimpleRefCount & | operator= (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::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 | |
double | DbmFromW (double w) const |
Transforms a Watt value to Dbm. | |
double | DbmToW (double dbm) const |
Transforms a Dbm value to Watt. | |
int64_t | DoAssignStreams (int64_t stream) override |
Assign a fixed random variable stream number to the random variables used by this model. | |
double | DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override |
PropagationLossModel. | |
Private Attributes | |
double | m_frequency |
the carrier frequency | |
double | m_heightAboveZ |
antenna height above the node's Z coordinate | |
double | m_lambda |
the carrier wavelength | |
double | m_minDistance |
minimum distance for the model | |
double | m_systemLoss |
the system loss (linear factor) | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
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. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
a Two-Ray Ground propagation loss model ported from NS2
Two-ray ground reflection model.
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:
In the implementation, is calculated as , where m/s is the speed of light in vacuum, and is the frequency in Hz which can be configured by the user via the Frequency attribute.
Definition at line 347 of file propagation-loss-model.h.
ns3::TwoRayGroundPropagationLossModel::TwoRayGroundPropagationLossModel | ( | ) |
Definition at line 322 of file propagation-loss-model.cc.
|
delete |
Transforms a Watt value to Dbm.
w | the Watt value |
Definition at line 379 of file propagation-loss-model.cc.
Transforms a Dbm value to Watt.
dbm | the Dbm value |
Definition at line 372 of file propagation-loss-model.cc.
|
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.
stream | first stream index to use |
Implements ns3::PropagationLossModel.
Definition at line 459 of file propagation-loss-model.cc.
|
overrideprivatevirtual |
txPowerDbm | current transmission power (in dBm) |
a | the mobility model of the source |
b | the mobility model of the destination |
Implements ns3::PropagationLossModel.
Definition at line 386 of file propagation-loss-model.cc.
References m_heightAboveZ, m_lambda, m_minDistance, m_systemLoss, and NS_LOG_DEBUG.
double ns3::TwoRayGroundPropagationLossModel::GetFrequency | ( | ) | const |
Definition at line 366 of file propagation-loss-model.cc.
References m_frequency.
Referenced by GetTypeId().
double ns3::TwoRayGroundPropagationLossModel::GetMinDistance | ( | ) | const |
Definition at line 346 of file propagation-loss-model.cc.
References m_minDistance.
Referenced by GetTypeId().
double ns3::TwoRayGroundPropagationLossModel::GetSystemLoss | ( | ) | const |
Definition at line 334 of file propagation-loss-model.cc.
References m_systemLoss.
Referenced by GetTypeId().
|
static |
Get the type ID.
Definition at line 287 of file propagation-loss-model.cc.
References GetFrequency(), GetMinDistance(), GetSystemLoss(), m_heightAboveZ, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), SetFrequency(), SetMinDistance(), ns3::TypeId::SetParent(), and SetSystemLoss().
|
delete |
void ns3::TwoRayGroundPropagationLossModel::SetFrequency | ( | double | frequency | ) |
frequency | (Hz) |
Set the carrier frequency used in the TwoRayGround model calculation.
Definition at line 358 of file propagation-loss-model.cc.
References m_frequency, and m_lambda.
Referenced by GetTypeId().
void ns3::TwoRayGroundPropagationLossModel::SetHeightAboveZ | ( | double | heightAboveZ | ) |
heightAboveZ | the model antenna height above the node's Z coordinate |
Set the model antenna height above the node's Z coordinate
Definition at line 352 of file propagation-loss-model.cc.
References m_heightAboveZ.
void ns3::TwoRayGroundPropagationLossModel::SetMinDistance | ( | double | minDistance | ) |
minDistance | the minimum distance |
Below this distance, the txpower is returned unmodified as the rxpower.
Definition at line 340 of file propagation-loss-model.cc.
References m_minDistance.
Referenced by GetTypeId().
void ns3::TwoRayGroundPropagationLossModel::SetSystemLoss | ( | double | systemLoss | ) |
systemLoss | (linear factor, dimension-less) |
Set the system loss used by the TwoRayGround propagation model. Value should be greater than or equal to 1; the default of 1 corresponds to no system loss.
Definition at line 327 of file propagation-loss-model.cc.
References m_systemLoss, and NS_ABORT_MSG_UNLESS.
Referenced by GetTypeId().
|
private |
the carrier frequency
Definition at line 426 of file propagation-loss-model.h.
Referenced by GetFrequency(), and SetFrequency().
|
private |
antenna height above the node's Z coordinate
Definition at line 429 of file propagation-loss-model.h.
Referenced by DoCalcRxPower(), GetTypeId(), and SetHeightAboveZ().
|
private |
the carrier wavelength
Definition at line 425 of file propagation-loss-model.h.
Referenced by DoCalcRxPower(), and SetFrequency().
|
private |
minimum distance for the model
Definition at line 428 of file propagation-loss-model.h.
Referenced by DoCalcRxPower(), GetMinDistance(), and SetMinDistance().
|
private |
the system loss (linear factor)
Definition at line 427 of file propagation-loss-model.h.
Referenced by DoCalcRxPower(), GetSystemLoss(), and SetSystemLoss().