This model provides means for simulating the following propagation phenomena in the presence of buildings: More...

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

Inheritance diagram for ns3::BuildingsPropagationLossModel:

Collaboration diagram for ns3::BuildingsPropagationLossModel:

Classes
class	ShadowingLoss
	This model allows the computation of shadowing loss. More...

Public Member Functions
	BuildingsPropagationLossModel ()

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

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

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'. More...

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

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

PropagationLossModel &	operator= (const PropagationLossModel &)=delete

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 ()
	Constructor. More...

	~Object () override
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose ()
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one. More...

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized () const
	Check if the object has been initialized. More...

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

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () 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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID. More...

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

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

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

Protected Member Functions
int64_t	DoAssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model. More...

double	EvaluateSigma (Ptr< MobilityBuildingInfo > a, Ptr< MobilityBuildingInfo > b) const
	Calculate the Standard deviation of the normal distribution used to calculate the shadowing. More...

double	ExternalWallLoss (Ptr< MobilityBuildingInfo > a) const
	Calculate the external wall loss. More...

double	GetShadowing (Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
	Calculate the shadowing loss. More...

double	HeightLoss (Ptr< MobilityBuildingInfo > n) const
	Calculate the height loss. More...

double	InternalWallsLoss (Ptr< MobilityBuildingInfo > a, Ptr< MobilityBuildingInfo > b) const
	Calculate the internal wall loss. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoDispose ()
	Destructor implementation. More...

virtual void	DoInitialize ()
	Initialize() implementation. More...

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed. More...

Protected Attributes
double	m_lossInternalWall
	loss from internal walls (in dBm) More...

Ptr< NormalRandomVariable >	m_randVariable
	Random variable. More...

std::map< Ptr< MobilityModel >, std::map< Ptr< MobilityModel >, ShadowingLoss > >	m_shadowingLossMap
	Map of the shadowng loss. More...

double	m_shadowingSigmaExtWalls
	Standard deviation of the normal distribution used to calculate the shadowing due to ext walls. More...

double	m_shadowingSigmaIndoor
	Standard deviation of the normal distribution used to calculate the shadowing for indoor nodes. More...

double	m_shadowingSigmaOutdoor
	Standard deviation of the normal distribution used to calculate the shadowing for outdoor nodes. More...

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

Detailed Description

This model provides means for simulating the following propagation phenomena in the presence of buildings:

shadowing (indoor, outdoor)
external wall penetration loss
internal wall penetration loss

The distance-dependent component of propagation loss is deferred to derived classes which are expected to implement the GetLoss method.

Warning: This model works only when MobilityBuildingInfo is aggreegated to the mobility model

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/PhyEntities/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/PhyEntities/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"
"/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::BuildingsPropagationLossModel"

Attributes

InternalWallLoss: Additional loss for each internal wall [dB]
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 5
- Flags: constructwriteread
ShadowSigmaExtWalls: Standard deviation of the normal distribution used to calculate the shadowing due to ext walls
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 5
- Flags: constructwriteread
ShadowSigmaIndoor: Standard deviation of the normal distribution used to calculate the shadowing for indoor nodes
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 8
- Flags: constructwriteread
ShadowSigmaOutdoor: Standard deviation of the normal distribution used to calculate the shadowing for outdoor nodes
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 7
- Flags: constructwriteread

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

Definition at line 55 of file buildings-propagation-loss-model.h.

Constructor & Destructor Documentation

◆ BuildingsPropagationLossModel()

ns3::BuildingsPropagationLossModel::BuildingsPropagationLossModel ( )

Definition at line 106 of file buildings-propagation-loss-model.cc.

References m_randVariable.

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::BuildingsPropagationLossModel::DoAssignStreams ( int64_t stream )

overrideprotectedvirtual

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 233 of file buildings-propagation-loss-model.cc.

References m_randVariable.

◆ DoCalcRxPower()

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

overridevirtual

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 225 of file buildings-propagation-loss-model.cc.

References GetLoss(), and GetShadowing().

Here is the call graph for this function:

◆ EvaluateSigma()

double ns3::BuildingsPropagationLossModel::EvaluateSigma	(	Ptr< MobilityBuildingInfo >	a,
		Ptr< MobilityBuildingInfo >	b
	)		const

protected

Calculate the Standard deviation of the normal distribution used to calculate the shadowing.

Parameters

a	Room A data
b	Room B data

Returns: the Standard deviation of the normal distribution

Definition at line 193 of file buildings-propagation-loss-model.cc.

References m_shadowingSigmaExtWalls, m_shadowingSigmaIndoor, m_shadowingSigmaOutdoor, and two-ray-to-three-gpp-ch-calibration::sigma.

Referenced by GetShadowing().

Here is the caller graph for this function:

◆ ExternalWallLoss()

double ns3::BuildingsPropagationLossModel::ExternalWallLoss ( Ptr< MobilityBuildingInfo > a ) const

protected

Calculate the external wall loss.

Parameters

a	Building data

Returns: the propagation loss (in dBm)

Definition at line 112 of file buildings-propagation-loss-model.cc.

References ns3::Building::ConcreteWithoutWindows, ns3::Building::ConcreteWithWindows, ns3::Building::StoneBlocks, and ns3::Building::Wood.

Referenced by ns3::HybridBuildingsPropagationLossModel::GetLoss(), and ns3::OhBuildingsPropagationLossModel::GetLoss().

Here is the caller graph for this function:

◆ GetLoss()

virtual double ns3::BuildingsPropagationLossModel::GetLoss	(	Ptr< MobilityModel >	a,
		Ptr< MobilityModel >	b
	)		const

pure virtual

Parameters

a	the mobility model of the source
b	the mobility model of the destination

Returns: the propagation loss (in dBm)

Implemented in ns3::OhBuildingsPropagationLossModel, and ns3::HybridBuildingsPropagationLossModel.

Referenced by DoCalcRxPower(), and GetShadowing().

Here is the caller graph for this function:

◆ GetShadowing()

double ns3::BuildingsPropagationLossModel::GetShadowing	(	Ptr< MobilityModel >	a,
		Ptr< MobilityModel >	b
	)		const

protected

Calculate the shadowing loss.

Parameters

a	Room A data
b	Room B data

Returns: the propagation loss (in dBm)

Definition at line 156 of file buildings-propagation-loss-model.cc.

References EvaluateSigma(), GetLoss(), ns3::Object::GetObject(), m_randVariable, m_shadowingLossMap, NS_ASSERT_MSG, and two-ray-to-three-gpp-ch-calibration::sigma.

Referenced by DoCalcRxPower().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::BuildingsPropagationLossModel::GetTypeId ( )

static

Get the type ID.

Returns: The object TypeId.

Definition at line 66 of file buildings-propagation-loss-model.cc.

References m_lossInternalWall, m_shadowingSigmaExtWalls, m_shadowingSigmaIndoor, m_shadowingSigmaOutdoor, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ HeightLoss()

double ns3::BuildingsPropagationLossModel::HeightLoss ( Ptr< MobilityBuildingInfo > n ) const

protected

Calculate the height loss.

Parameters

n	Building data

Returns: the propagation loss (in dBm)

Definition at line 136 of file buildings-propagation-loss-model.cc.

Referenced by ns3::HybridBuildingsPropagationLossModel::GetLoss().

Here is the caller graph for this function:

◆ InternalWallsLoss()

double ns3::BuildingsPropagationLossModel::InternalWallsLoss	(	Ptr< MobilityBuildingInfo >	a,
		Ptr< MobilityBuildingInfo >	b
	)		const

protected

Calculate the internal wall loss.

Parameters

a	Room A data
b	Room B data

Returns: the propagation loss (in dBm)

Definition at line 146 of file buildings-propagation-loss-model.cc.

References m_lossInternalWall.

Referenced by ns3::HybridBuildingsPropagationLossModel::GetLoss(), and ns3::OhBuildingsPropagationLossModel::GetLoss().

Here is the caller graph for this function:

Member Data Documentation

◆ m_lossInternalWall

double ns3::BuildingsPropagationLossModel::m_lossInternalWall

protected

loss from internal walls (in dBm)

Definition at line 106 of file buildings-propagation-loss-model.h.

Referenced by GetTypeId(), and InternalWallsLoss().

◆ m_randVariable

Ptr<NormalRandomVariable> ns3::BuildingsPropagationLossModel::m_randVariable

protected

Random variable.

Definition at line 157 of file buildings-propagation-loss-model.h.

Referenced by BuildingsPropagationLossModel(), DoAssignStreams(), and GetShadowing().

◆ m_shadowingLossMap

std::map<Ptr<MobilityModel>, std::map<Ptr<MobilityModel>, ShadowingLoss> > ns3::BuildingsPropagationLossModel::m_shadowingLossMap

mutableprotected

Map of the shadowng loss.

Definition at line 139 of file buildings-propagation-loss-model.h.

Referenced by GetShadowing().

◆ m_shadowingSigmaExtWalls

double ns3::BuildingsPropagationLossModel::m_shadowingSigmaExtWalls

protected

Standard deviation of the normal distribution used to calculate the shadowing due to ext walls.

Definition at line 150 of file buildings-propagation-loss-model.h.

Referenced by EvaluateSigma(), and GetTypeId().

◆ m_shadowingSigmaIndoor

double ns3::BuildingsPropagationLossModel::m_shadowingSigmaIndoor

protected

Standard deviation of the normal distribution used to calculate the shadowing for indoor nodes.

Definition at line 156 of file buildings-propagation-loss-model.h.

Referenced by EvaluateSigma(), and GetTypeId().

◆ m_shadowingSigmaOutdoor

double ns3::BuildingsPropagationLossModel::m_shadowingSigmaOutdoor

protected

Standard deviation of the normal distribution used to calculate the shadowing for outdoor nodes.

Definition at line 153 of file buildings-propagation-loss-model.h.

Referenced by EvaluateSigma(), and GetTypeId().

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

src/buildings/model/buildings-propagation-loss-model.h
src/buildings/model/buildings-propagation-loss-model.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

◆ BuildingsPropagationLossModel()

Member Function Documentation

◆ DoAssignStreams()

◆ DoCalcRxPower()

◆ EvaluateSigma()

◆ ExternalWallLoss()

◆ GetLoss()

◆ GetShadowing()

◆ GetTypeId()

◆ HeightLoss()

◆ InternalWallsLoss()

Member Data Documentation

◆ m_lossInternalWall

◆ m_randVariable

◆ m_shadowingLossMap

◆ m_shadowingSigmaExtWalls

◆ m_shadowingSigmaIndoor

◆ m_shadowingSigmaOutdoor