A Discrete-Event Network Simulator
API
ns3::Cost231PropagationLossModel Class Reference

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 ()
 
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...
 
void SetBSAntennaHeight (double height)
 Set the BS antenna height. More...
 
void SetLambda (double lambda)
 Set the wavelength. More...
 
void SetLambda (double frequency, double speed)
 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 ()
 
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< PropagationLossModelGetNext ()
 Gets the next PropagationLossModel in the chain of loss models that act on the signal. More...
 
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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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

 Cost231PropagationLossModel (const Cost231PropagationLossModel &)
 Copy constructor. More...
 
virtual int64_t DoAssignStreams (int64_t stream)
 Subclasses must implement this; those not using random variables can return zero. More...
 
virtual double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 Returns the Rx Power taking into account only the particular PropagatinLossModel. More...
 
Cost231PropagationLossModeloperator= (const Cost231PropagationLossModel &)
 Copy constructor. 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...
 

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::YansWifiChannel/PropagationLossModel/$ns3::Cost231PropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/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

ns3::Cost231PropagationLossModel::Cost231PropagationLossModel ( )

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

References m_shadowing.

ns3::Cost231PropagationLossModel::Cost231PropagationLossModel ( const Cost231PropagationLossModel )
private

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

int64_t ns3::Cost231PropagationLossModel::DoAssignStreams ( int64_t  stream)
privatevirtual

Subclasses must implement this; those not using random variables can return zero.

Implements ns3::PropagationLossModel.

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

double ns3::Cost231PropagationLossModel::DoCalcRxPower ( double  txPowerDbm,
Ptr< MobilityModel a,
Ptr< MobilityModel b 
) const
privatevirtual

Returns the Rx Power taking into account only the particular PropagatinLossModel.

Parameters
txPowerDbmcurrent transmission power (in dBm)
athe mobility model of the source
bthe 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:

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.

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.

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

Get the propagation loss.

Parameters
athe mobility model of the source
bthe 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:

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:

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.

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.

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:

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

Copy constructor.

Defined and unimplemented to avoid misuse

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

Set the BS antenna height.

Parameters
heightBS antenna height [m]

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

References m_BSAntennaHeight.

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

Set the wavelength.

Parameters
lambdathe wavelength

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

References m_frequency, and m_lambda.

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

Set the wavelength.

Parameters
frequencythe signal frequency [Hz]
speedthe signal speed [m/s]

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

References m_frequency, and m_lambda.

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

Set the minimum model distance.

Parameters
minDistancethe 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:

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

Set the shadowing value.

Parameters
shadowingthe shadowing value

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

References m_shadowing.

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

Set the SS antenna height.

Parameters
heightSS antenna height [m]

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

References m_SSAntennaHeight.

Member Data Documentation

double ns3::Cost231PropagationLossModel::m_BSAntennaHeight
private

BS Antenna Height [m].

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

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

double ns3::Cost231PropagationLossModel::m_frequency
private

frequency [Hz]

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

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

double ns3::Cost231PropagationLossModel::m_lambda
private

The wavelength.

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

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

double ns3::Cost231PropagationLossModel::m_minDistance
private

minimum distance [m]

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

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

double ns3::Cost231PropagationLossModel::m_shadowing
private

Shadowing loss [dB].

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

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

double ns3::Cost231PropagationLossModel::m_SSAntennaHeight
private

SS Antenna Height [m].

Definition at line 144 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: