The COST-Hata-Model is the most often cited of the COST 231 models. More...

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

Inheritance diagram for ns3::Cost231PropagationLossModel:

Collaboration diagram for ns3::Cost231PropagationLossModel:

Public Member Functions
	Cost231PropagationLossModel ()

	Cost231PropagationLossModel (const Cost231PropagationLossModel &)=delete

double	GetBSAntennaHeight (void) const
	Get the BS antenna height. More...

double	GetLambda (void) const
	Get the wavelength. More...

double	GetLoss (Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
	Get the propagation loss. More...

double	GetMinDistance (void) const
	Get the minimum model distance. More...

double	GetShadowing (void)
	Get the shadowing value. More...

double	GetSSAntennaHeight (void) const
	Get the SS antenna height. More...

Cost231PropagationLossModel &	operator= (const Cost231PropagationLossModel &)=delete

void	SetBSAntennaHeight (double height)
	Set the BS antenna height. More...

void	SetLambda (double frequency, double speed)
	Set the wavelength. More...

void	SetLambda (double lambda)
	Set the wavelength. More...

void	SetMinDistance (double minDistance)
	Set the minimum model distance. More...

void	SetShadowing (double shadowing)
	Set the shadowing value. More...

void	SetSSAntennaHeight (double height)
	Set the SS antenna height. More...

Public Member Functions inherited from ns3::PropagationLossModel
	PropagationLossModel ()

	PropagationLossModel (const PropagationLossModel &)=delete

virtual	~PropagationLossModel ()

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

virtual	~Object ()
	Destructor. More...

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

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

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

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this 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...

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

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

bool	IsInitialized (void) 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 (void) const
	Get the reference count of the object. More...

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

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

void	Unref (void) 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 erros. 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 (void)
	Get the type ID. More...

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

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

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

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

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

Private Attributes
double	m_BSAntennaHeight
	BS Antenna Height [m]. More...

double	m_frequency
	frequency [Hz] More...

double	m_lambda
	The wavelength. More...

double	m_minDistance
	minimum distance [m] More...

double	m_shadowing
	Shadowing loss [dB]. More...

double	m_SSAntennaHeight
	SS Antenna Height [m]. More...

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

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

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

virtual void	NotifyNewAggregate (void)
	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 (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

The COST-Hata-Model is the most often cited of the COST 231 models.

Also called the Hata Model PCS Extension, it is a radio propagation model that extends the Hata Model (which in turn is based on the Okumura Model) to cover a more elaborated range of frequencies. COST (COperation europ�enne dans le domaine de la recherche Scientifique et Technique) is a European Union Forum for cooperative scientific research which has developed this model accordingly to various experiments and researches. This model is applicable to urban areas. To further evaluate Path Loss in Suburban or Rural Quasi-open/Open Areas. Frequency: 1500 MHz to 2000 MHz Mobile Station Antenna Height: 1 up to 10m Base station Antenna Height: 30m to 200m Link Distance:up to 20 km

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::Cost231PropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::Cost231PropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::Cost231PropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::Cost231PropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::Cost231PropagationLossModel"
"/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::Cost231PropagationLossModel"
"/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::Cost231PropagationLossModel"

Attributes

Lambda: The wavelength (default is 2.3 GHz at 300 000 km/s).
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.130435
- Flags: construct write read
Frequency: The Frequency (default is 2.3 GHz).
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 2.3e+09
- Flags: construct write read
BSAntennaHeight: BS Antenna Height (default is 50m).
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 50
- Flags: construct write read
SSAntennaHeight: SS Antenna Height (default is 3m).
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 3
- Flags: construct write read
MinDistance: The distance under which the propagation model refuses to give results (m)
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.5
- Flags: construct write read

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

Definition at line 50 of file cost231-propagation-loss-model.h.

Constructor & Destructor Documentation

◆ Cost231PropagationLossModel() [1/2]

ns3::Cost231PropagationLossModel::Cost231PropagationLossModel ( )

Definition at line 71 of file cost231-propagation-loss-model.cc.

References m_shadowing.

◆ Cost231PropagationLossModel() [2/2]

ns3::Cost231PropagationLossModel::Cost231PropagationLossModel ( const Cost231PropagationLossModel & )

delete

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::Cost231PropagationLossModel::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 178 of file cost231-propagation-loss-model.cc.

◆ DoCalcRxPower()

double ns3::Cost231PropagationLossModel::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 172 of file cost231-propagation-loss-model.cc.

References GetLoss().

Here is the call graph for this function:

◆ GetBSAntennaHeight()

double ns3::Cost231PropagationLossModel::GetBSAntennaHeight ( void ) const

Get the BS antenna height.

Returns: BS antenna height [m]

Definition at line 125 of file cost231-propagation-loss-model.cc.

References m_BSAntennaHeight.

◆ GetLambda()

double ns3::Cost231PropagationLossModel::GetLambda ( void ) const

Get the wavelength.

Returns: the wavelength

Definition at line 102 of file cost231-propagation-loss-model.cc.

References m_lambda.

◆ GetLoss()

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

Get the propagation loss.

Parameters

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

Returns: the propagation loss (in dBm)

Definition at line 143 of file cost231-propagation-loss-model.cc.

References ns3::MobilityModel::GetDistanceFrom(), m_BSAntennaHeight, m_frequency, m_minDistance, m_shadowing, m_SSAntennaHeight, and NS_LOG_DEBUG.

Referenced by DoCalcRxPower().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMinDistance()

double ns3::Cost231PropagationLossModel::GetMinDistance ( void ) const

Get the minimum model distance.

Returns: the minimum model distance

Definition at line 113 of file cost231-propagation-loss-model.cc.

References m_minDistance.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetShadowing()

double ns3::Cost231PropagationLossModel::GetShadowing ( void )

Get the shadowing value.

Returns: the shadowing value

Definition at line 84 of file cost231-propagation-loss-model.cc.

References m_shadowing.

◆ GetSSAntennaHeight()

double ns3::Cost231PropagationLossModel::GetSSAntennaHeight ( void ) const

Get the SS antenna height.

Returns: SS antenna height [m]

Definition at line 137 of file cost231-propagation-loss-model.cc.

References m_SSAntennaHeight.

◆ GetTypeId()

TypeId ns3::Cost231PropagationLossModel::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 37 of file cost231-propagation-loss-model.cc.

References GetMinDistance(), m_BSAntennaHeight, m_frequency, m_lambda, m_SSAntennaHeight, ns3::MakeDoubleAccessor(), SetMinDistance(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ operator=()

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

delete

◆ SetBSAntennaHeight()

void ns3::Cost231PropagationLossModel::SetBSAntennaHeight ( double height )

Set the BS antenna height.

Parameters

height BS antenna height [m]

Definition at line 119 of file cost231-propagation-loss-model.cc.

References m_BSAntennaHeight.

◆ SetLambda() [1/2]

void ns3::Cost231PropagationLossModel::SetLambda	(	double	frequency,
		double	speed
	)

Set the wavelength.

Parameters

frequency	the signal frequency [Hz]
speed	the signal speed [m/s]

Definition at line 77 of file cost231-propagation-loss-model.cc.

References m_frequency, and m_lambda.

◆ SetLambda() [2/2]

void ns3::Cost231PropagationLossModel::SetLambda ( double lambda )

Set the wavelength.

Parameters

lambda the wavelength

Definition at line 95 of file cost231-propagation-loss-model.cc.

References m_frequency, and m_lambda.

◆ SetMinDistance()

void ns3::Cost231PropagationLossModel::SetMinDistance ( double minDistance )

Set the minimum model distance.

Parameters

minDistance the minimum model distance

Definition at line 108 of file cost231-propagation-loss-model.cc.

References m_minDistance.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetShadowing()

void ns3::Cost231PropagationLossModel::SetShadowing ( double shadowing )

Set the shadowing value.

Parameters

shadowing the shadowing value

Definition at line 89 of file cost231-propagation-loss-model.cc.

References m_shadowing.

◆ SetSSAntennaHeight()

void ns3::Cost231PropagationLossModel::SetSSAntennaHeight ( double height )

Set the SS antenna height.

Parameters

height SS antenna height [m]

Definition at line 131 of file cost231-propagation-loss-model.cc.

References m_SSAntennaHeight.

Member Data Documentation

◆ m_BSAntennaHeight

double ns3::Cost231PropagationLossModel::m_BSAntennaHeight

private

BS Antenna Height [m].

Definition at line 135 of file cost231-propagation-loss-model.h.

Referenced by GetBSAntennaHeight(), GetLoss(), GetTypeId(), and SetBSAntennaHeight().

◆ m_frequency

double ns3::Cost231PropagationLossModel::m_frequency

private

frequency [Hz]

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

Referenced by GetLoss(), GetTypeId(), and SetLambda().

◆ m_lambda

double ns3::Cost231PropagationLossModel::m_lambda

private

The wavelength.

Definition at line 137 of file cost231-propagation-loss-model.h.

Referenced by GetLambda(), GetTypeId(), and SetLambda().

◆ m_minDistance

double ns3::Cost231PropagationLossModel::m_minDistance

private

minimum distance [m]

Definition at line 138 of file cost231-propagation-loss-model.h.

Referenced by GetLoss(), GetMinDistance(), and SetMinDistance().

◆ m_shadowing

double ns3::Cost231PropagationLossModel::m_shadowing

private

Shadowing loss [dB].

Definition at line 140 of file cost231-propagation-loss-model.h.

Referenced by Cost231PropagationLossModel(), GetLoss(), GetShadowing(), and SetShadowing().

◆ m_SSAntennaHeight

double ns3::Cost231PropagationLossModel::m_SSAntennaHeight

private

SS Antenna Height [m].

Definition at line 136 of file cost231-propagation-loss-model.h.

Referenced by GetLoss(), GetSSAntennaHeight(), GetTypeId(), and SetSSAntennaHeight().

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

src/propagation/model/cost231-propagation-loss-model.h
src/propagation/model/cost231-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

◆ Cost231PropagationLossModel() [1/2]

◆ Cost231PropagationLossModel() [2/2]

Member Function Documentation

◆ DoAssignStreams()

◆ DoCalcRxPower()

◆ GetBSAntennaHeight()

◆ GetLambda()

◆ GetLoss()

◆ GetMinDistance()

◆ GetShadowing()

◆ GetSSAntennaHeight()

◆ GetTypeId()

◆ operator=()

◆ SetBSAntennaHeight()

◆ SetLambda() [1/2]

◆ SetLambda() [2/2]

◆ SetMinDistance()

◆ SetShadowing()

◆ SetSSAntennaHeight()

Member Data Documentation

◆ m_BSAntennaHeight

◆ m_frequency

◆ m_lambda

◆ m_minDistance

◆ m_shadowing

◆ m_SSAntennaHeight