spectrum-aware propagation loss model More...

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

Inheritance diagram for ns3::SpectrumPropagationLossModel:

Collaboration diagram for ns3::SpectrumPropagationLossModel:

Public Member Functions
	SpectrumPropagationLossModel ()

	~SpectrumPropagationLossModel () 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'.

Ptr< SpectrumValue >	CalcRxPowerSpectralDensity (Ptr< const SpectrumSignalParameters > params, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const
	This method is to be called to calculate.

Ptr< SpectrumPropagationLossModel >	GetNext () const
	Return the pointer to the next SpectrumPropagationLossModel, if any.

void	SetNext (Ptr< SpectrumPropagationLossModel > next)
	Used to chain various instances of SpectrumPropagationLossModel.

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

void	DoDispose () override
	Destructor implementation.

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
virtual Ptr< SpectrumValue >	DoCalcRxPowerSpectralDensity (Ptr< const SpectrumSignalParameters > params, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const =0

Private Attributes
Ptr< SpectrumPropagationLossModel >	m_next
	SpectrumPropagationLossModel chained to this one.

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

spectrum-aware propagation loss model

Introspection did not find any typical Config paths.

Interface for propagation loss models to be adopted when transmissions are modeled with a power spectral density by means of the SpectrumValue class.

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

Definition at line 43 of file spectrum-propagation-loss-model.h.

Constructor & Destructor Documentation

◆ SpectrumPropagationLossModel()

ns3::SpectrumPropagationLossModel::SpectrumPropagationLossModel ( )

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

◆ ~SpectrumPropagationLossModel()

ns3::SpectrumPropagationLossModel::~SpectrumPropagationLossModel ( )

override

Definition at line 38 of file spectrum-propagation-loss-model.cc.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::SpectrumPropagationLossModel::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 SpectrumPropagationLossModels chained together, this method will also assign streams to the downstream models.

Parameters

stream the stream index offset start

Returns: the number of stream indices assigned by this model

Definition at line 82 of file spectrum-propagation-loss-model.cc.

References DoAssignStreams(), and m_next.

Here is the call graph for this function:

◆ CalcRxPowerSpectralDensity()

Ptr< SpectrumValue > ns3::SpectrumPropagationLossModel::CalcRxPowerSpectralDensity	(	Ptr< const SpectrumSignalParameters >	params,
		Ptr< const MobilityModel >	a,
		Ptr< const MobilityModel >	b
	)		const

This method is to be called to calculate.

Parameters

params	the spectrum signal parameters.
a	sender mobility
b	receiver mobility

Returns: set of values Vs frequency representing the received power in the same units used for the txPower parameter.

Definition at line 69 of file spectrum-propagation-loss-model.cc.

References DoCalcRxPowerSpectralDensity(), and m_next.

Here is the call graph for this function:

◆ DoAssignStreams()

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

protectedpure virtual

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

Implemented in ns3::ConstantSpectrumPropagationLossModel, ns3::FriisSpectrumPropagationLossModel, and ns3::TraceFadingLossModel.

Referenced by AssignStreams().

Here is the caller graph for this function:

◆ DoCalcRxPowerSpectralDensity()

virtual Ptr< SpectrumValue > ns3::SpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity	(	Ptr< const SpectrumSignalParameters >	params,
		Ptr< const MobilityModel >	a,
		Ptr< const MobilityModel >	b
	)		const

privatepure virtual

Parameters

params	the spectrum signal parameters.
a	sender mobility
b	receiver mobility

Returns: set of values Vs frequency representing the received power in the same units used for the txPower parameter.

Implemented in ns3::ConstantSpectrumPropagationLossModel, ns3::FriisSpectrumPropagationLossModel, and ns3::TraceFadingLossModel.

Referenced by CalcRxPowerSpectralDensity().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::SpectrumPropagationLossModel::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 43 of file spectrum-propagation-loss-model.cc.

References m_next.