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

Uses Thorp's approximation to compute pathloss. More...

#include "uan-prop-model-thorp.h"

+ Inheritance diagram for ns3::UanPropModelThorp:
+ Collaboration diagram for ns3::UanPropModelThorp:

Public Member Functions

 UanPropModelThorp ()
 Default constructor. More...
 
virtual ~UanPropModelThorp ()
 Destructor. More...
 
virtual Time GetDelay (Ptr< MobilityModel > a, Ptr< MobilityModel > b, UanTxMode mode)
 Finds propagation delay between nodes a and b. More...
 
virtual double GetPathLossDb (Ptr< MobilityModel > a, Ptr< MobilityModel > b, UanTxMode mode)
 Computes pathloss between nodes a and b. More...
 
virtual UanPdp GetPdp (Ptr< MobilityModel > a, Ptr< MobilityModel > b, UanTxMode mode)
 Get the PDP for the path between two nodes. More...
 
- Public Member Functions inherited from ns3::UanPropModel
virtual void Clear (void)
 Clear all pointer references. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual Time GetDelay (Ptr< MobilityModel > a, Ptr< MobilityModel > b, UanTxMode mode)=0
 Finds propagation delay between nodes a and b. More...
 
virtual double GetPathLossDb (Ptr< MobilityModel > a, Ptr< MobilityModel > b, UanTxMode txMode)=0
 Computes pathloss between nodes a and b. More...
 
virtual UanPdp GetPdp (Ptr< MobilityModel > a, Ptr< MobilityModel > b, UanTxMode mode)=0
 Get the PDP for the path between two nodes. 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)
 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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::UanPropModel
static TypeId GetTypeId (void)
 Register this type. 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 GetAttenDbKm (double freqKhz)
 Get the attenuation in dB / km. More...
 
double GetAttenDbKyd (double freqKhz)
 Get the attenuation in dB / 1000 yards. More...
 

Private Attributes

double m_SpreadCoef
 Spreading coefficient used in calculation of Thorp's approximation. 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

Uses Thorp's approximation to compute pathloss.

Assumes implulse PDP.

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::UanPropModelThorp"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::UanPropModelThorp"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::UanChannel/PropagationModel/$ns3::UanPropModelThorp"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/RemoteStationManagers/[i]/Channel/$ns3::UanChannel/PropagationModel/$ns3::UanPropModelThorp"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::UanPropModelThorp"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/PhyEntities/[i]/Channel/$ns3::UanChannel/PropagationModel/$ns3::UanPropModelThorp"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::UanPropModelThorp"
  • "/ChannelList/[i]/$ns3::UanChannel/PropagationModel/$ns3::UanPropModelThorp"

Attributes

  • SpreadCoef: Spreading coefficient used in calculation of Thorp's approximation.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1.5
    • Flags: construct write read

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

Definition at line 35 of file uan-prop-model-thorp.h.

Constructor & Destructor Documentation

◆ UanPropModelThorp()

ns3::UanPropModelThorp::UanPropModelThorp ( )

Default constructor.

Definition at line 31 of file uan-prop-model-thorp.cc.

◆ ~UanPropModelThorp()

ns3::UanPropModelThorp::~UanPropModelThorp ( )
virtual

Destructor.

Definition at line 35 of file uan-prop-model-thorp.cc.

Member Function Documentation

◆ GetAttenDbKm()

double ns3::UanPropModelThorp::GetAttenDbKm ( double  freqKhz)
private

Get the attenuation in dB / km.

Parameters
freqKhzThe channel center frequency, in kHz.
Returns
The attenuation, in dB/km.

Definition at line 84 of file uan-prop-model-thorp.cc.

Referenced by GetAttenDbKyd(), and GetPathLossDb().

+ Here is the caller graph for this function:

◆ GetAttenDbKyd()

double ns3::UanPropModelThorp::GetAttenDbKyd ( double  freqKhz)
private

Get the attenuation in dB / 1000 yards.

Parameters
freqKhzThe channel center frequency, in kHz.
Returns
The attenuation, in dB / 1000 yards.

Definition at line 77 of file uan-prop-model-thorp.cc.

References GetAttenDbKm().

+ Here is the call graph for this function:

◆ GetDelay()

Time ns3::UanPropModelThorp::GetDelay ( Ptr< MobilityModel a,
Ptr< MobilityModel b,
UanTxMode  mode 
)
virtual

Finds propagation delay between nodes a and b.

Parameters
aPtr to mobility model of node a.
bPtr to mobility model of node b.
modeTX mode of transmission.
Returns
Propagation delay.

Implements ns3::UanPropModel.

Definition at line 71 of file uan-prop-model-thorp.cc.

References ns3::MobilityModel::GetDistanceFrom(), and ns3::Seconds().

+ Here is the call graph for this function:

◆ GetPathLossDb()

double ns3::UanPropModelThorp::GetPathLossDb ( Ptr< MobilityModel a,
Ptr< MobilityModel b,
UanTxMode  txMode 
)
virtual

Computes pathloss between nodes a and b.

Parameters
aPtr to mobility model of node a
bPtr to mobility model of node b
txModeTX mode of transmission between a and b
Returns
Pathloss in dB re 1 uPa

Implements ns3::UanPropModel.

Definition at line 56 of file uan-prop-model-thorp.cc.

References GetAttenDbKm(), ns3::UanTxMode::GetCenterFreqHz(), ns3::MobilityModel::GetDistanceFrom(), and m_SpreadCoef.

+ Here is the call graph for this function:

◆ GetPdp()

UanPdp ns3::UanPropModelThorp::GetPdp ( Ptr< MobilityModel a,
Ptr< MobilityModel b,
UanTxMode  mode 
)
virtual

Get the PDP for the path between two nodes.

Parameters
aPtr to mobility model of node a.
bPtr to mobility model of node b.
modeTX mode of transmission from a to b.
Returns
PDP for link between nodes a and b.

Implements ns3::UanPropModel.

Definition at line 65 of file uan-prop-model-thorp.cc.

References ns3::UanPdp::CreateImpulsePdp().

+ Here is the call graph for this function:

◆ GetTypeId()

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

Register this type.

Returns
The object TypeId.

Definition at line 40 of file uan-prop-model-thorp.cc.

References m_SpreadCoef, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_SpreadCoef

double ns3::UanPropModelThorp::m_SpreadCoef
private

Spreading coefficient used in calculation of Thorp's approximation.

Definition at line 68 of file uan-prop-model-thorp.h.

Referenced by GetPathLossDb(), and GetTypeId().


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