A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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
 
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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::PropagationLossModel
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

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
 

Private Attributes

CitySize m_citySize
 
EnvironmentType m_environment
 
double m_frequency
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. 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:

  • /ChannelList/[i]/$ns3::WifiChannel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::OkumuraHataPropagationLossModel
  • /ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::OkumuraHataPropagationLossModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$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.

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

Constructor & Destructor Documentation

ns3::OkumuraHataPropagationLossModel::OkumuraHataPropagationLossModel ( )

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

ns3::OkumuraHataPropagationLossModel::~OkumuraHataPropagationLossModel ( )
virtual

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

Member Function Documentation

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

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

Implements ns3::PropagationLossModel.

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

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

Implements ns3::PropagationLossModel.

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

References GetLoss().

+ Here is the call graph for this function:

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 80 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, ns3::SubUrbanEnvironment, and ns3::Vector3D::z.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Member Data Documentation

CitySize ns3::OkumuraHataPropagationLossModel::m_citySize
private

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

Referenced by GetLoss(), and GetTypeId().

EnvironmentType ns3::OkumuraHataPropagationLossModel::m_environment
private

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

Referenced by GetLoss(), and GetTypeId().

double ns3::OkumuraHataPropagationLossModel::m_frequency
private

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

Referenced by GetLoss(), and GetTypeId().


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