the ITU-R 1411 NLOS over rooftop propagation model More...

#include "itu-r-1411-nlos-over-rooftop-propagation-loss-model.h"

Inheritance diagram for ns3::ItuR1411NlosOverRooftopPropagationLossModel:

Collaboration diagram for ns3::ItuR1411NlosOverRooftopPropagationLossModel:

Public Member Functions
	ItuR1411NlosOverRooftopPropagationLossModel ()

	ItuR1411NlosOverRooftopPropagationLossModel (const ItuR1411NlosOverRooftopPropagationLossModel &)=delete

	~ItuR1411NlosOverRooftopPropagationLossModel () override

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

ItuR1411NlosOverRooftopPropagationLossModel &	operator= (const ItuR1411NlosOverRooftopPropagationLossModel &)=delete

void	SetFrequency (double freq)
	Set the operating frequency.

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 ()
	Get the type ID.

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_buildingSeparation
	in meters

double	m_buildingsExtend
	in meters

CitySize	m_citySize
	Dimension of the city.

EnvironmentType	m_environment
	Environment Scenario.

double	m_frequency
	frequency in MHz

double	m_lambda
	wavelength

double	m_rooftopHeight
	in meters

double	m_streetsOrientation
	in degrees [0,90]

double	m_streetsWidth
	in meters

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

the ITU-R 1411 NLOS over rooftop propagation model

This class implements the ITU-R 1411 LOS propagation model for Non-Line-of-Sight (NLoS) short range outdoor communication over rooftops in the frequency range 300 MHz to 100 GHz. For more information about the model, please see the propagation module documentation in .rst format.

Config Paths

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

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

Attributes

BuildingSeparation: The separation between buildings
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 50
- Flags: constructwriteread
BuildingsExtend: The distance over which the buildings extend
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 80
- Flags: constructwriteread
CitySize: Dimension of the city
- Set with class: ns3::EnumValue<N3ns38CitySizeE>
- Underlying type: Small|Medium|Large
- Initial value: Large
- Flags: constructwriteread
Environment: Environment Scenario
- Set with class: ns3::EnumValue<N3ns315EnvironmentTypeE>
- Underlying type: Urban|SubUrban|OpenAreas
- Initial value: Urban
- Flags: constructwriteread
Frequency: The Frequency (default is 2.106 GHz).
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 2.16e+09
- Flags: constructwrite
RooftopLevel: The height of the rooftop level in meters
- Set with class: ns3::DoubleValue
- Underlying type: double 0:90
- Initial value: 20
- Flags: constructwriteread
StreetsOrientation: The orientation of streets in degrees [0,90] with respect to the direction of propagation
- Set with class: ns3::DoubleValue
- Underlying type: double 0:90
- Initial value: 45
- Flags: constructwriteread
StreetsWidth: The width of streets
- Set with class: ns3::DoubleValue
- Underlying type: double 0:1000
- Initial value: 20
- Flags: constructwriteread

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

Definition at line 42 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.h.

Constructor & Destructor Documentation

◆ ItuR1411NlosOverRooftopPropagationLossModel() [1/2]

ns3::ItuR1411NlosOverRooftopPropagationLossModel::ItuR1411NlosOverRooftopPropagationLossModel ( )

Definition at line 104 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.cc.

◆ ~ItuR1411NlosOverRooftopPropagationLossModel()

ns3::ItuR1411NlosOverRooftopPropagationLossModel::~ItuR1411NlosOverRooftopPropagationLossModel ( )

override

Definition at line 109 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.cc.

◆ ItuR1411NlosOverRooftopPropagationLossModel() [2/2]

ns3::ItuR1411NlosOverRooftopPropagationLossModel::ItuR1411NlosOverRooftopPropagationLossModel ( const ItuR1411NlosOverRooftopPropagationLossModel & )

delete

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::ItuR1411NlosOverRooftopPropagationLossModel::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 239 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.cc.

◆ DoCalcRxPower()

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::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 231 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.cc.

References GetLoss().

Here is the call graph for this function:

◆ GetLoss()

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

Parameters

a	the first mobility model
b	the second mobility model

Returns: the loss in dBm for the propagation between the two given mobility models

Definition at line 114 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.cc.

References ns3::LargeCity, m_buildingSeparation, m_buildingsExtend, m_citySize, m_environment, m_frequency, m_lambda, m_rooftopHeight, m_streetsOrientation, m_streetsWidth, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::UrbanEnvironment.

Referenced by DoCalcRxPower().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ItuR1411NlosOverRooftopPropagationLossModel::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 38 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.cc.

References ns3::LargeCity, m_buildingSeparation, m_buildingsExtend, m_citySize, m_environment, m_rooftopHeight, m_streetsOrientation, m_streetsWidth, ns3::MakeDoubleAccessor(), ns3::MakeEnumChecker(), ns3::MediumCity, ns3::OpenAreasEnvironment, SetFrequency(), ns3::TypeId::SetParent(), ns3::SmallCity, ns3::SubUrbanEnvironment, and ns3::UrbanEnvironment.

Here is the call graph for this function:

◆ operator=()

ItuR1411NlosOverRooftopPropagationLossModel & ns3::ItuR1411NlosOverRooftopPropagationLossModel::operator= ( const ItuR1411NlosOverRooftopPropagationLossModel & )

delete

◆ SetFrequency()

void ns3::ItuR1411NlosOverRooftopPropagationLossModel::SetFrequency ( double freq )

Set the operating frequency.

Parameters

freq	the frequency in Hz

Definition at line 224 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.cc.

References m_frequency, and m_lambda.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_buildingSeparation

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_buildingSeparation

private

in meters

Definition at line 92 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.h.

Referenced by GetLoss(), and GetTypeId().

◆ m_buildingsExtend

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_buildingsExtend

private

in meters

Definition at line 91 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.h.

Referenced by GetLoss(), and GetTypeId().

◆ m_citySize

CitySize ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_citySize

private

Dimension of the city.

Definition at line 87 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.h.

Referenced by GetLoss(), and GetTypeId().

◆ m_environment

EnvironmentType ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_environment

private

Environment Scenario.

Definition at line 86 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.h.

Referenced by GetLoss(), and GetTypeId().

◆ m_frequency

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_frequency

private

frequency in MHz

Definition at line 84 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.h.

Referenced by GetLoss(), and SetFrequency().

◆ m_lambda

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_lambda

private

wavelength

Definition at line 85 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.h.

Referenced by GetLoss(), and SetFrequency().

◆ m_rooftopHeight

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_rooftopHeight

private

in meters

Definition at line 88 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.h.

Referenced by GetLoss(), and GetTypeId().

◆ m_streetsOrientation

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_streetsOrientation

private

in degrees [0,90]

Definition at line 89 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.h.

Referenced by GetLoss(), and GetTypeId().

◆ m_streetsWidth

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_streetsWidth

private

in meters

Definition at line 90 of file itu-r-1411-nlos-over-rooftop-propagation-loss-model.h.

Referenced by GetLoss(), and GetTypeId().

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

src/propagation/model/itu-r-1411-nlos-over-rooftop-propagation-loss-model.h
src/propagation/model/itu-r-1411-nlos-over-rooftop-propagation-loss-model.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

◆ ItuR1411NlosOverRooftopPropagationLossModel() [1/2]

◆ ~ItuR1411NlosOverRooftopPropagationLossModel()

◆ ItuR1411NlosOverRooftopPropagationLossModel() [2/2]

Member Function Documentation

◆ DoAssignStreams()

◆ DoCalcRxPower()

◆ GetLoss()

◆ GetTypeId()

◆ operator=()

◆ SetFrequency()

Member Data Documentation

◆ m_buildingSeparation

◆ m_buildingsExtend

◆ m_citySize

◆ m_environment

◆ m_frequency

◆ m_lambda

◆ m_rooftopHeight

◆ m_streetsOrientation

◆ m_streetsWidth