A class implementing the TR 45.820 model for building losses. More...

#include "building-penetration-loss.h"

Inheritance diagram for ns3::lorawan::BuildingPenetrationLoss:

Collaboration diagram for ns3::lorawan::BuildingPenetrationLoss:

Public Member Functions
	BuildingPenetrationLoss ()
	Default constructor.

	~BuildingPenetrationLoss () override
	Destructor.

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.

int	GetPValue () const
	Generate a random p value.

double	GetTor1 (Ptr< MobilityModel > b) const
	Get the Tor1 value used in the TR 45.820 standard to account for internal wall loss.

double	GetWallLoss (Ptr< MobilityModel > b) const
	Compute the wall loss associated to this mobility model.

int	GetWallLossValue () const
	Get a value to compute the wall loss.

Private Attributes
std::map< Ptr< MobilityModel >, int >	m_pMap
	A map linking each mobility model to a p value.

Ptr< UniformRandomVariable >	m_uniformRV
	An uniform RV.

std::map< Ptr< MobilityModel >, int >	m_wallLossMap
	A map linking each mobility model to a value deciding its external wall loss.

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

A class implementing the TR 45.820 model for building losses.

Definition at line 38 of file building-penetration-loss.h.

Constructor & Destructor Documentation

◆ BuildingPenetrationLoss()

ns3::lorawan::BuildingPenetrationLoss::BuildingPenetrationLoss ( )

Default constructor.

Definition at line 45 of file building-penetration-loss.cc.

References m_uniformRV, and NS_LOG_FUNCTION_NOARGS.

◆ ~BuildingPenetrationLoss()

ns3::lorawan::BuildingPenetrationLoss::~BuildingPenetrationLoss ( )

override

Destructor.

Definition at line 53 of file building-penetration-loss.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::lorawan::BuildingPenetrationLoss::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 132 of file building-penetration-loss.cc.

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

Here is the call graph for this function:

◆ DoCalcRxPower()

double ns3::lorawan::BuildingPenetrationLoss::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 59 of file building-penetration-loss.cc.

References GetTor1(), ns3::UniformRandomVariable::GetValue(), GetWallLoss(), m_uniformRV, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_INFO.

Here is the call graph for this function:

◆ GetPValue()

int ns3::lorawan::BuildingPenetrationLoss::GetPValue ( ) const

private

Generate a random p value.

The distribution of the returned value is as specified in TR 45.820.

Returns: A random value in the 0-3 range.

Definition at line 139 of file building-penetration-loss.cc.

References ns3::UniformRandomVariable::GetValue(), m_uniformRV, and NS_LOG_FUNCTION_NOARGS.

Referenced by GetTor1().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTor1()

double ns3::lorawan::BuildingPenetrationLoss::GetTor1 ( Ptr< MobilityModel > b ) const

private

Get the Tor1 value used in the TR 45.820 standard to account for internal wall loss.

Parameters

b	The mobility model of the node we want to compute the value for.

Returns: The tor1 value.

Definition at line 219 of file building-penetration-loss.cc.

References GetPValue(), ns3::UniformRandomVariable::GetValue(), m_pMap, m_uniformRV, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by DoCalcRxPower().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::lorawan::BuildingPenetrationLoss::GetTypeId ( )

static

Register this type.

Returns: The object TypeId.

Definition at line 36 of file building-penetration-loss.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetWallLoss()

double ns3::lorawan::BuildingPenetrationLoss::GetWallLoss ( Ptr< MobilityModel > b ) const

private

Compute the wall loss associated to this mobility model.

Parameters

b	The mobility model associated to the node whose wall loss we need to compute.

Returns: The power loss due to external walls.

Definition at line 189 of file building-penetration-loss.cc.

References ns3::UniformRandomVariable::GetValue(), GetWallLossValue(), m_uniformRV, m_wallLossMap, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by DoCalcRxPower().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetWallLossValue()

int ns3::lorawan::BuildingPenetrationLoss::GetWallLossValue ( ) const

private

Get a value to compute the wall loss.

The distribution of the returned value is as specified in TR 45.820.

Returns: A random value in the 0-2 range.

Definition at line 166 of file building-penetration-loss.cc.

References ns3::UniformRandomVariable::GetValue(), m_uniformRV, and NS_LOG_FUNCTION_NOARGS.

Referenced by GetWallLoss().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_pMap

std::map<Ptr<MobilityModel>, int> ns3::lorawan::BuildingPenetrationLoss::m_pMap

mutableprivate

A map linking each mobility model to a p value.

Definition at line 92 of file building-penetration-loss.h.

Referenced by GetTor1().

◆ m_uniformRV

Ptr<UniformRandomVariable> ns3::lorawan::BuildingPenetrationLoss::m_uniformRV

private

An uniform RV.

Definition at line 87 of file building-penetration-loss.h.

Referenced by BuildingPenetrationLoss(), DoAssignStreams(), DoCalcRxPower(), GetPValue(), GetTor1(), GetWallLoss(), and GetWallLossValue().

◆ m_wallLossMap

std::map<Ptr<MobilityModel>, int> ns3::lorawan::BuildingPenetrationLoss::m_wallLossMap

mutableprivate

A map linking each mobility model to a value deciding its external wall loss.

Definition at line 98 of file building-penetration-loss.h.

Referenced by GetWallLoss().

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

src/lorawan/model/building-penetration-loss.h
src/lorawan/model/building-penetration-loss.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BuildingPenetrationLoss()

◆ ~BuildingPenetrationLoss()

Member Function Documentation

◆ DoAssignStreams()

◆ DoCalcRxPower()

◆ GetPValue()

◆ GetTor1()

◆ GetTypeId()

◆ GetWallLoss()

◆ GetWallLossValue()

Member Data Documentation

◆ m_pMap

◆ m_uniformRV

◆ m_wallLossMap