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

this class implements the Okumura Hata propagation loss model More...

#include "okumura-hata-propagation-loss-model.h"

+ Inheritance diagram for ns3::OkumuraHataPropagationLossModel:
+ Collaboration diagram for ns3::OkumuraHataPropagationLossModel:

Public Member Functions

 OkumuraHataPropagationLossModel ()
 
virtual ~OkumuraHataPropagationLossModel ()
 
double GetLoss (Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 
- 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<>
Ptr< ObjectGetObject () 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< ObjectGetObject (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)
 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

 OkumuraHataPropagationLossModel (const OkumuraHataPropagationLossModel &)
 Copy constructor. More...
 
int64_t DoAssignStreams (int64_t stream) override
 Subclasses must implement this; those not using random variables can return zero. More...
 
double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
 Returns the Rx Power taking into account only the particular PropagationLossModel. More...
 
OkumuraHataPropagationLossModeloperator= (const OkumuraHataPropagationLossModel &)
 Copy constructor. More...
 

Private Attributes

CitySize m_citySize
 Size of the city. More...
 
EnvironmentType m_environment
 Environment Scenario. More...
 
double m_frequency
 frequency in Hz 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

this class implements the Okumura Hata propagation loss model

this class implements the Okumura Hata propagation loss model, which is used to model open area pathloss for distances > 1 Km and frequencies ranging from 150 MHz to 2.0 GHz. For more information about the model, please see the propagation module documentation in .rst format.

Config Paths

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

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

Attributes

  • Frequency: The propagation frequency in Hz
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 2.16e+09
    • Flags: construct write read
  • Environment: Environment Scenario
    • Set with class: ns3::EnumValue
    • Underlying type:
    • Initial value: Urban
    • Flags: construct write read
  • CitySize: Dimension of the city
    • Set with class: ns3::EnumValue
    • Underlying type:
    • Initial value: Large
    • Flags: construct write read

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

Definition at line 43 of file okumura-hata-propagation-loss-model.h.

Constructor & Destructor Documentation

◆ OkumuraHataPropagationLossModel() [1/2]

ns3::OkumuraHataPropagationLossModel::OkumuraHataPropagationLossModel ( )

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

◆ ~OkumuraHataPropagationLossModel()

ns3::OkumuraHataPropagationLossModel::~OkumuraHataPropagationLossModel ( )
virtual

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

◆ OkumuraHataPropagationLossModel() [2/2]

ns3::OkumuraHataPropagationLossModel::OkumuraHataPropagationLossModel ( const OkumuraHataPropagationLossModel )
private

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::OkumuraHataPropagationLossModel::DoAssignStreams ( int64_t  stream)
overrideprivatevirtual

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

Parameters
streamthe stream index offset start
Returns
the number of stream indices assigned by this model

Implements ns3::PropagationLossModel.

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

◆ DoCalcRxPower()

double ns3::OkumuraHataPropagationLossModel::DoCalcRxPower ( double  txPowerDbm,
Ptr< MobilityModel a,
Ptr< MobilityModel b 
) const
overrideprivatevirtual

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

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 148 of file okumura-hata-propagation-loss-model.cc.

References GetLoss().

+ Here is the call graph for this function:

◆ GetLoss()

double ns3::OkumuraHataPropagationLossModel::GetLoss ( Ptr< MobilityModel a,
Ptr< MobilityModel b 
) const
Parameters
athe first mobility model
bthe second mobility model
Returns
the loss in dBm for the propagation between the two given mobility models

Definition at line 76 of file okumura-hata-propagation-loss-model.cc.

References ns3::MobilityModel::GetDistanceFrom(), ns3::MobilityModel::GetPosition(), ns3::LargeCity, m_citySize, m_environment, m_frequency, NS_ASSERT_MSG, NS_LOG_INFO, ns3::OpenAreasEnvironment, and ns3::SubUrbanEnvironment.

Referenced by DoCalcRxPower(), and OkumuraHataPropagationLossModelTestCase::DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::OkumuraHataPropagationLossModel::GetTypeId ( void  )
static

◆ operator=()

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

Copy constructor.

Defined and unimplemented to avoid misuse

Returns

Member Data Documentation

◆ m_citySize

CitySize ns3::OkumuraHataPropagationLossModel::m_citySize
private

Size of the city.

Definition at line 87 of file okumura-hata-propagation-loss-model.h.

Referenced by GetLoss(), and GetTypeId().

◆ m_environment

EnvironmentType ns3::OkumuraHataPropagationLossModel::m_environment
private

Environment Scenario.

Definition at line 86 of file okumura-hata-propagation-loss-model.h.

Referenced by GetLoss(), and GetTypeId().

◆ m_frequency

double ns3::OkumuraHataPropagationLossModel::m_frequency
private

frequency in Hz

Definition at line 88 of file okumura-hata-propagation-loss-model.h.

Referenced by GetLoss(), and GetTypeId().


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