Propagation loss model for spatially correlated shadowing in a city. More...

#include "correlated-shadowing-propagation-loss-model.h"

Inheritance diagram for ns3::lorawan::CorrelatedShadowingPropagationLossModel:

Collaboration diagram for ns3::lorawan::CorrelatedShadowingPropagationLossModel:

Classes
class	Position
	Stores x,y values and overrides critical operators. More...

class	ShadowingMap
	This initializes the shadowing map with a grid of independent shadowing values, one m_correlationDistance meters apart from the next one. More...

Public Member Functions
	CorrelatedShadowingPropagationLossModel ()
	Default constructor.

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 ()
	Register this type.

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.

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.

Private Attributes
double	m_correlationDistance
	The correlation distance for the ShadowingMap.

std::map< std::pair< int, int >, Ptr< ShadowingMap > >	m_shadowingGrid
	Map linking a square to a ShadowingMap.

Additional Inherited Members
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.

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

Propagation loss model for spatially correlated shadowing in a city.

Definition at line 38 of file correlated-shadowing-propagation-loss-model.h.

Constructor & Destructor Documentation

◆ CorrelatedShadowingPropagationLossModel()

ns3::lorawan::CorrelatedShadowingPropagationLossModel::CorrelatedShadowingPropagationLossModel ( )

Default constructor.

Definition at line 52 of file correlated-shadowing-propagation-loss-model.cc.

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::lorawan::CorrelatedShadowingPropagationLossModel::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 123 of file correlated-shadowing-propagation-loss-model.cc.

◆ DoCalcRxPower()

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

Implements ns3::PropagationLossModel.

Definition at line 57 of file correlated-shadowing-propagation-loss-model.cc.

References m_correlationDistance, m_shadowingGrid, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_INFO.

◆ GetTypeId()

TypeId ns3::lorawan::CorrelatedShadowingPropagationLossModel::GetTypeId ( )

static

Register this type.

Returns: The object TypeId.

Definition at line 35 of file correlated-shadowing-propagation-loss-model.cc.

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

Here is the call graph for this function:

Member Data Documentation

◆ m_correlationDistance

double ns3::lorawan::CorrelatedShadowingPropagationLossModel::m_correlationDistance

private

The correlation distance for the ShadowingMap.

Definition at line 160 of file correlated-shadowing-propagation-loss-model.h.

Referenced by DoCalcRxPower(), ns3::lorawan::CorrelatedShadowingPropagationLossModel::ShadowingMap::GetLoss(), and GetTypeId().

◆ m_shadowingGrid

std::map<std::pair<int, int>, Ptr<ShadowingMap> > ns3::lorawan::CorrelatedShadowingPropagationLossModel::m_shadowingGrid

mutableprivate

Map linking a square to a ShadowingMap.

Each square of the shadowing grid has a corresponding ShadowingMap, and a square is identified by a pair of coordinates. Coordinates are computed as such:

   o---------o---------o---------o---------o---------o
   |         |         |    '    |         |         |
   |  (-2,2) |  (-1,2) |  (0,2)  |  (1,2)  |  (2,2)  |
   |         |         |    '    |         |         |
   o---------o---------o----+----o---------o---------o
   |         |         |    '    |         |         |
   |  (-2,1) |  (-1,1) |  (0,1)  |  (1,1)  |  (2,1)  |
   |         |         |    '    |         |         |
   o---------o---------o----+----o---------o---------o
   |         |         |    '    |         |         |
   |--(-2,0)-+--(-1,0)-+--(0,0)--+--(1,0)--+--(2,0)--|
   |         |         |    '    |         |         |
   o---------o---------o----+----o---------o---------o
   |         |         |    '    |         |         |
   | (-2,-1) | (-1,-1) | (0,-1)  | (1,-1)  | (2,-1)  |
   |         |         |    '    |         |         |
   o---------o---------o----+----o---------o---------o
   |         |         |    '    |         |         |
   | (-2,-2) | (-1,-2) | (0,-2)  | (1,-2)  | (2,-2)  |
   |         |         |    '    |         |         |
   o---------o---------o---------o---------o---------o

For each one of these coordinates, a ShadowingMap is computed. That is, each one of the points belonging to the same square sees the same shadowing for the points around it. This is one level of correlation for the shadowing, i.e. close nodes transmitting to the same point will see the same shadowing since they are using the same shadowing map. Further, the ShadowingMap will be "smooth": when transmitting from point a to points b and c, the shadowing experienced by b and c will be similar if they are close (ideally, within a correlation distance).

Definition at line 199 of file correlated-shadowing-propagation-loss-model.h.

Referenced by DoCalcRxPower().

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