A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::FriisPropagationLossModel Class Reference

a Friis propagation loss model More...

#include <propagation-loss-model.h>

+ Inheritance diagram for ns3::FriisPropagationLossModel:
+ Collaboration diagram for ns3::FriisPropagationLossModel:

Public Member Functions

 FriisPropagationLossModel ()
double GetLambda (void) const
double GetMinDistance (void) const
double GetSystemLoss (void) const
void SetLambda (double frequency, double speed)
void SetLambda (double lambda)
void SetMinDistance (double minDistance)
void SetSystemLoss (double systemLoss)
- Public Member Functions inherited from ns3::PropagationLossModel
 PropagationLossModel ()
virtual ~PropagationLossModel ()
int64_t AssignStreams (int64_t stream)
double CalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
Ptr< PropagationLossModelGetNext ()
 Gets the next PropagationLossModel in the chain of loss models that act on the signal.
void SetNext (Ptr< PropagationLossModel > next)
 Enables a chain of loss models to act on the signal.
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
AggregateIterator GetAggregateIterator (void) const
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::FriisPropagationLossModel.

Private Member Functions

 FriisPropagationLossModel (const FriisPropagationLossModel &o)
double DbmFromW (double w) const
double DbmToW (double dbm) const
virtual int64_t DoAssignStreams (int64_t stream)
virtual double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
FriisPropagationLossModeloperator= (const FriisPropagationLossModel &o)

Private Attributes

double m_lambda
double m_minDistance
double m_systemLoss

Static Private Attributes

static const double PI = 3.14159265358979323846

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoDispose (void)
virtual void DoStart (void)
virtual void NotifyNewAggregate (void)

Detailed Description

a Friis propagation loss model

The Friis propagation loss model was first described in "A Note on a Simple Transmission Formula", by "Harald T. Friis".

The original equation was described as: $ \frac{P_r}{P_t} = \frac{A_r A_t}{d^2\lambda^2} $ with the following equation for the case of an isotropic antenna with no heat loss: $ A_{isotr.} = \frac{\lambda^2}{4\pi} $

The final equation becomes: $ \frac{P_r}{P_t} = \frac{\lambda^2}{(4 \pi d)^2} $

Modern extensions to this original equation are: $ P_r = \frac{P_t G_t G_r \lambda^2}{(4 \pi d)^2 L}$

With:

  • $ P_r $ : reception power (W)
  • $ P_t $ : transmission power (W)
  • $ G_t $ : transmission gain (unit-less)
  • $ G_r $ : reception gain (unit-less)
  • $ \lambda $ : wavelength (m)
  • $ d $ : distance (m)
  • $ L $ : system loss (unit-less)

This model is invalid for small distance values. The current implementation returns the txpower as the rxpower for any distance smaller than MinDistance.

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

Constructor & Destructor Documentation

ns3::FriisPropagationLossModel::FriisPropagationLossModel ( )

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

ns3::FriisPropagationLossModel::FriisPropagationLossModel ( const FriisPropagationLossModel o)
private

Member Function Documentation

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

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

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

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

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

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

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

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

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

+ Here is the call graph for this function:

double ns3::FriisPropagationLossModel::GetLambda ( void  ) const
Returns
the current wavelength (m)

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

References m_lambda.

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

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

References m_minDistance.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

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

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

References m_systemLoss.

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

This method returns the TypeId associated to ns3::FriisPropagationLossModel.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::FriisPropagationLossModel

Attributes defined for this type:

  • Lambda: The wavelength (default is 5.15 GHz at 300 000 km/s).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.0582524
    • Flags: construct write read
  • SystemLoss: The system loss
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: construct write read
  • MinDistance: The distance under which the propagation model refuses to give results (m)
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.5
    • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::PropagationLossModel.

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

References GetMinDistance(), m_lambda, m_systemLoss, SetMinDistance(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

FriisPropagationLossModel& ns3::FriisPropagationLossModel::operator= ( const FriisPropagationLossModel o)
private
void ns3::FriisPropagationLossModel::SetLambda ( double  frequency,
double  speed 
)
Parameters
frequency(Hz)
speed(m/s)

Set the main wavelength used in the Friis model calculation.

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

References m_lambda.

void ns3::FriisPropagationLossModel::SetLambda ( double  lambda)
Parameters
lambda(m) the wavelength

Set the main wavelength used in the Friis model calculation.

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

References m_lambda.

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

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

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

References m_minDistance.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

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

Set the system loss used by the Friis propagation model.

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

References m_systemLoss.

Member Data Documentation

double ns3::FriisPropagationLossModel::m_lambda
private

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

Referenced by DoCalcRxPower(), GetLambda(), GetTypeId(), and SetLambda().

double ns3::FriisPropagationLossModel::m_minDistance
private

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

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

double ns3::FriisPropagationLossModel::m_systemLoss
private

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

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

const double ns3::FriisPropagationLossModel::PI = 3.14159265358979323846
staticprivate

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

Referenced by DoCalcRxPower().


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