Modelize the propagation loss through a transmission medium. More...

#include <propagation-loss-model.h>

Inheritance diagram for ns3::PropagationLossModel:

Collaboration diagram for ns3::PropagationLossModel:

Public Member Functions
	PropagationLossModel ()

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

Ptr< PropagationLossModel >	GetNext ()
	Gets the next PropagationLossModel in the chain of loss models that act on the signal. More...

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

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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

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)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Member Functions
	PropagationLossModel (const PropagationLossModel &o)

virtual int64_t	DoAssignStreams (int64_t stream)=0
	Subclasses must implement this; those not using random variables can return zero. More...

virtual double	DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const =0

PropagationLossModel &	operator= (const PropagationLossModel &o)

Private Attributes
Ptr< PropagationLossModel >	m_next

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Modelize the propagation loss through a transmission medium.

Calculate the receive power (dbm) from a transmit power (dbm) and a mobility model for the source and destination positions.

Config Paths

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

/ChannelList/[i]/$ns3::WifiChannel/$ns3::YansWifiChannel/PropagationLossModel
/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel
/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel

No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::PropagationLossModel::PropagationLossModel ( )

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

ns3::PropagationLossModel::~PropagationLossModel ( )

virtual

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

ns3::PropagationLossModel::PropagationLossModel ( const PropagationLossModel & o )

private

Member Function Documentation

int64_t ns3::PropagationLossModel::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'.

Return the number of streams (possibly zero) that have been assigned. If there are PropagationLossModels chained together, this method will also assign streams to the downstream models.

Parameters

stream

Returns: the number of stream indices assigned by this model

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

References AssignStreams(), DoAssignStreams(), and m_next.

Referenced by AssignStreams(), and ns3::YansWifiChannel::AssignStreams().

Here is the call graph for this function:

Here is the caller graph for this function:

double ns3::PropagationLossModel::CalcRxPower	(	double	txPowerDbm,
		Ptr< MobilityModel >	a,
		Ptr< MobilityModel >	b
	)		const

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)

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

References CalcRxPower(), DoCalcRxPower(), and m_next.

Referenced by CalcRxPower(), MatrixPropagationLossModelTestCase::DoRun(), RangePropagationLossModelTestCase::DoRun(), JakesPropagationExample::Next(), ns3::SimpleOfdmWimaxChannel::Send(), ns3::YansWifiChannel::Send(), ns3::SingleModelSpectrumChannel::StartTx(), ns3::MultiModelSpectrumChannel::StartTx(), TestDeterministic(), TestDeterministicByTime(), and TestProbabilistic().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual int64_t ns3::PropagationLossModel::DoAssignStreams ( int64_t stream )

privatepure virtual

Subclasses must implement this; those not using random variables can return zero.

Referenced by AssignStreams().

Here is the caller graph for this function:

virtual double ns3::PropagationLossModel::DoCalcRxPower	(	double	txPowerDbm,
		Ptr< MobilityModel >	a,
		Ptr< MobilityModel >	b
	)		const

privatepure virtual

Referenced by CalcRxPower().

Here is the caller graph for this function:

Ptr< PropagationLossModel > ns3::PropagationLossModel::GetNext ( void )

Gets the next PropagationLossModel in the chain of loss models that act on the signal.

Returns: The next PropagationLossModel in the chain

This method of chaining propagation loss models only works commutatively if the propagation loss of all models in the chain are independent of transmit power.

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

References m_next.

TypeId ns3::PropagationLossModel::GetTypeId ( void )

static

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

PropagationLossModel& ns3::PropagationLossModel::operator= ( const PropagationLossModel & o )

private

void ns3::PropagationLossModel::SetNext ( Ptr< PropagationLossModel > next )

Enables a chain of loss models to act on the signal.

Parameters

next	The next PropagationLossModel to add to the chain

This method of chaining propagation loss models only works commutatively if the propagation loss of all models in the chain are independent of transmit power.

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

References m_next.

Referenced by ns3::SpectrumChannelHelper::AddPropagationLoss(), ns3::YansWifiChannelHelper::Create(), and main().

Here is the caller graph for this function: