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

a Jakes narrowband propagation model. More...

#include "jakes-propagation-loss-model.h"

+ Inheritance diagram for ns3::JakesPropagationLossModel:
+ Collaboration diagram for ns3::JakesPropagationLossModel:

Public Member Functions

 JakesPropagationLossModel ()
 
 JakesPropagationLossModel (const JakesPropagationLossModel &)=delete
 
virtual ~JakesPropagationLossModel ()
 
JakesPropagationLossModeloperator= (const JakesPropagationLossModel &)=delete
 
- 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)
 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 ()
 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...
 

Protected Member Functions

virtual void DoDispose () override
 Destructor implementation. More...
 
virtual int64_t DoAssignStreams (int64_t stream)=0
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
- 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...
 

Private Member Functions

int64_t DoAssignStreams (int64_t stream) override
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
 PropagationLossModel. More...
 
Ptr< UniformRandomVariableGetUniformRandomVariable () const
 Get the underlying RNG stream. More...
 

Private Attributes

PropagationCache< JakesProcessm_propagationCache
 Propagation cache. More...
 
Ptr< UniformRandomVariablem_uniformVariable
 random stream More...
 

Friends

class JakesProcess
 

Additional Inherited Members

Detailed Description

a Jakes narrowband propagation model.

Symmetrical cache for JakesProcess

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/RemoteStationManagers/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/RemoteStationManagers/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/PhyEntities/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/PhyEntities/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::JakesPropagationLossModel"

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

Definition at line 36 of file jakes-propagation-loss-model.h.

Constructor & Destructor Documentation

◆ JakesPropagationLossModel() [1/2]

ns3::JakesPropagationLossModel::JakesPropagationLossModel ( )

Definition at line 33 of file jakes-propagation-loss-model.cc.

References m_uniformVariable, and ns3::ObjectBase::SetAttribute().

+ Here is the call graph for this function:

◆ ~JakesPropagationLossModel()

ns3::JakesPropagationLossModel::~JakesPropagationLossModel ( )
virtual

Definition at line 40 of file jakes-propagation-loss-model.cc.

◆ JakesPropagationLossModel() [2/2]

ns3::JakesPropagationLossModel::JakesPropagationLossModel ( const JakesPropagationLossModel )
delete

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::JakesPropagationLossModel::DoAssignStreams ( int64_t  stream)
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.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::PropagationLossModel.

Definition at line 83 of file jakes-propagation-loss-model.cc.

References m_uniformVariable, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

◆ DoCalcRxPower()

double ns3::JakesPropagationLossModel::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)

Spectrum model uid is not used in PropagationLossModel

Spectrum model uid is not used in PropagationLossModel

Implements ns3::PropagationLossModel.

Definition at line 62 of file jakes-propagation-loss-model.cc.

References m_propagationCache.

◆ DoDispose()

void ns3::JakesPropagationLossModel::DoDispose ( void  )
overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 55 of file jakes-propagation-loss-model.cc.

References m_propagationCache, and m_uniformVariable.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 44 of file jakes-propagation-loss-model.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetUniformRandomVariable()

Ptr< UniformRandomVariable > ns3::JakesPropagationLossModel::GetUniformRandomVariable ( ) const
private

Get the underlying RNG stream.

Returns
the RNG stream

Definition at line 77 of file jakes-propagation-loss-model.cc.

References m_uniformVariable.

◆ operator=()

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

Friends And Related Function Documentation

◆ JakesProcess

friend class JakesProcess
friend

Definition at line 55 of file jakes-propagation-loss-model.h.

Member Data Documentation

◆ m_propagationCache

PropagationCache<JakesProcess> ns3::JakesPropagationLossModel::m_propagationCache
mutableprivate

Propagation cache.

Definition at line 70 of file jakes-propagation-loss-model.h.

Referenced by DoCalcRxPower(), and DoDispose().

◆ m_uniformVariable

Ptr<UniformRandomVariable> ns3::JakesPropagationLossModel::m_uniformVariable
private

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