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

	~JakesPropagationLossModel () override

JakesPropagationLossModel &	operator= (const JakesPropagationLossModel &)=delete

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) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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.

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

virtual int64_t	DoAssignStreams (int64_t stream)=0
	Assign a fixed random variable stream number to the random variables used by this model.

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.

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.

double	DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
	PropagationLossModel.

Ptr< UniformRandomVariable >	GetUniformRandomVariable () const
	Get the underlying RNG stream.

Private Attributes
PropagationCache< JakesProcess >	m_propagationCache
	Propagation cache.

Ptr< UniformRandomVariable >	m_uniformVariable
	random stream

Friends
class	JakesProcess

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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::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 120 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ JakesPropagationLossModel() [1/2]

ns3::JakesPropagationLossModel::JakesPropagationLossModel ( )

Definition at line 32 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 ( )

override

Definition at line 39 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

stream first stream index to use

Returns: the number of stream indices assigned by this model

Implements ns3::PropagationLossModel.

Definition at line 89 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

txPowerDbm	current transmission power (in dBm)
a	the mobility model of the source
b	the mobility model of the destination

Returns: the reception power after adding/multiplying propagation loss (in dBm)

Spectrum model uid is not used in PropagationLossModel

Implements ns3::PropagationLossModel.

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

References m_propagationCache.

◆ DoDispose()

void ns3::JakesPropagationLossModel::DoDispose ( )

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 54 of file jakes-propagation-loss-model.cc.

References m_propagationCache, and m_uniformVariable.