A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::ItuR1411NlosOverRooftopPropagationLossModel Class Reference

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

double GetLoss (Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 
void SetFrequency (double freq)
 Set the operating frequency. 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
 
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

double m_buildingSeparation
 in meters More...
 
double m_buildingsExtend
 in meters More...
 
CitySize m_citySize
 
EnvironmentType m_environment
 
double m_frequency
 frequency in MHz More...
 
double m_lambda
 wavelength More...
 
double m_rooftopHeight
 in meters More...
 
double m_streetsOrientation
 in degrees [0,90] More...
 
double m_streetsWidth
 in meters More...
 

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

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:

  • /ChannelList/[i]/$ns3::WifiChannel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ItuR1411NlosOverRooftopPropagationLossModel
  • /ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ItuR1411NlosOverRooftopPropagationLossModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::ItuR1411NlosOverRooftopPropagationLossModel

Attributes

  • 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: construct write
  • Environment: Environment Scenario
    • Set with class: ns3::EnumValue
    • Underlying type: Urban|SubUrban|OpenAreas
    • Initial value: Urban
    • Flags: construct write read
  • CitySize: Dimension of the city
    • Set with class: ns3::EnumValue
    • Underlying type: Small|Medium|Large
    • Initial value: Large
    • Flags: construct write read
  • RooftopLevel: The height of the rooftop level in meters
  • StreetsOrientation: The orientation of streets in degrees [0,90] with respect to the direction of propagation
  • StreetsWidth: The width of streets
    • Set with class: ns3::DoubleValue
    • Underlying type: double 0:1000
    • Initial value: 20
    • Flags: construct write read
  • 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: construct write read
  • BuildingSeparation: The separation between buildings
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 50
    • Flags: construct write read

No TraceSources are defined for this type.

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

Member Function Documentation

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

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

Implements ns3::PropagationLossModel.

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

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

Implements ns3::PropagationLossModel.

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

References GetLoss().

+ Here is the call graph for this function:

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

References ns3::MobilityModel::GetDistanceFrom(), ns3::MobilityModel::GetPosition(), 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, ns3::UrbanEnvironment, and ns3::Vector3D::z.

Referenced by DoCalcRxPower().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Set the operating frequency.

Parameters
freqthe frequency in Hz

Definition at line 209 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

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_buildingSeparation
private

in meters

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

Referenced by GetLoss(), and GetTypeId().

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_buildingsExtend
private

in meters

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

Referenced by GetLoss(), and GetTypeId().

CitySize ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_citySize
private

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

Referenced by GetLoss(), and GetTypeId().

EnvironmentType ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_environment
private

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

Referenced by GetLoss(), and GetTypeId().

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_frequency
private

frequency in MHz

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

Referenced by GetLoss(), and SetFrequency().

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_lambda
private

wavelength

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

Referenced by GetLoss(), and SetFrequency().

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_rooftopHeight
private

in meters

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

Referenced by GetLoss(), and GetTypeId().

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_streetsOrientation
private

in degrees [0,90]

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

Referenced by GetLoss(), and GetTypeId().

double ns3::ItuR1411NlosOverRooftopPropagationLossModel::m_streetsWidth
private

in meters

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