A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::ThreeGppAntennaModel Class Reference

Antenna model based on a parabolic approximation of the main lobe radiation pattern. More...

#include "three-gpp-antenna-model.h"

+ Inheritance diagram for ns3::ThreeGppAntennaModel:
+ Collaboration diagram for ns3::ThreeGppAntennaModel:

Public Types

enum class  RadiationPattern { OUTDOOR , INDOOR }
 The different antenna radiation patterns defined in ITU-R M.2412. More...
 

Public Member Functions

 ThreeGppAntennaModel ()
 
 ~ThreeGppAntennaModel () override
 
double GetAntennaElementGain () const
 Get the maximum directional gain of the antenna element.
 
double GetGainDb (Angles a) override
 this method is expected to be re-implemented by each antenna model
 
double GetHorizontalBeamwidth () const
 Get the horizontal beamwidth of the antenna element.
 
double GetMaxAttenuation () const
 Get the maximum attenuation of the antenna element.
 
RadiationPattern GetRadiationPattern () const
 Get the antenna radiation pattern.
 
double GetSlaV () const
 Get the side-lobe attenuation in the vertical direction of the antenna element.
 
double GetVerticalBeamwidth () const
 Get the vertical beamwidth of the antenna element.
 
void SetRadiationPattern (RadiationPattern pattern)
 Set the antenna radiation pattern.
 
- Public Member Functions inherited from ns3::AntennaModel
 AntennaModel ()
 
 ~AntennaModel () override
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const final
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::AntennaModel
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Member Functions

void DoInitialize () override
 Initialize() implementation.
 
void SetIndoorAntennaPattern ()
 Set the radiation pattern for Indoor Hotspot - eMBB, Table 8-7 in Report ITU-R M.2412.
 
void SetOutdoorAntennaPattern ()
 Set the radiation pattern Dense Urban – eMBB, Rural – eMBB, Urban Macro – mMTC, and Urban Macro - URLLC, Table 8-6 in Report ITU-R M.2412.
 

Private Attributes

double m_aMax
 maximum attenuation (A_{max}) [dB]
 
double m_geMax
 maximum directional gain of the antenna element (G_{E,max}) [dBi]
 
double m_horizontalBeamwidthDegrees
 beamwidth in the horizontal direction $(\phi_{3dB})$ [deg]
 
RadiationPattern m_radiationPattern
 current antenna radiation pattern
 
double m_slaV
 side-lobe attenuation in the vertical direction (SLA_V) [dB]
 
double m_verticalBeamwidthDegrees
 beamwidth in the vertical direction $(\theta_{3dB})$ [deg]
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

Antenna model based on a parabolic approximation of the main lobe radiation pattern.

Introspection did not find any typical Config paths.

This class implements the parabolic model as described in 3GPP TR 38.901 v15.0.0


Attributes

No TraceSources are defined for this type.
Group: Antenna

Size of this type is 104 bytes (on a 64-bit architecture).

Definition at line 22 of file three-gpp-antenna-model.h.

Member Enumeration Documentation

◆ RadiationPattern

The different antenna radiation patterns defined in ITU-R M.2412.

Enumerator
OUTDOOR 
INDOOR 

Definition at line 28 of file three-gpp-antenna-model.h.

Constructor & Destructor Documentation

◆ ThreeGppAntennaModel()

ns3::ThreeGppAntennaModel::ThreeGppAntennaModel ( )

Definition at line 45 of file three-gpp-antenna-model.cc.

References OUTDOOR, and SetRadiationPattern().

+ Here is the call graph for this function:

◆ ~ThreeGppAntennaModel()

ns3::ThreeGppAntennaModel::~ThreeGppAntennaModel ( )
override

Definition at line 57 of file three-gpp-antenna-model.cc.

Member Function Documentation

◆ DoInitialize()

void ns3::ThreeGppAntennaModel::DoInitialize ( )
overrideprivatevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 51 of file three-gpp-antenna-model.cc.

References m_radiationPattern, NS_LOG_FUNCTION, and SetRadiationPattern().

+ Here is the call graph for this function:

◆ GetAntennaElementGain()

double ns3::ThreeGppAntennaModel::GetAntennaElementGain ( ) const

Get the maximum directional gain of the antenna element.

Returns
the maximum directional gain in dBi

Definition at line 129 of file three-gpp-antenna-model.cc.

References m_geMax.

◆ GetGainDb()

double ns3::ThreeGppAntennaModel::GetGainDb ( Angles a)
overridevirtual

this method is expected to be re-implemented by each antenna model

Parameters
athe spherical angles at which the radiation pattern should be evaluated
Returns
the power gain in dBi of the antenna radiation pattern at the specified angles; dBi means dB with respect to the gain of an isotropic radiator. Since a power gain is used, the efficiency of the antenna is expected to be included in the gain value.

Implements ns3::AntennaModel.

Definition at line 135 of file three-gpp-antenna-model.cc.

References ns3::Angles::GetAzimuth(), ns3::Angles::GetInclination(), m_aMax, m_geMax, m_horizontalBeamwidthDegrees, m_slaV, m_verticalBeamwidthDegrees, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::RadiansToDegrees().

+ Here is the call graph for this function:

◆ GetHorizontalBeamwidth()

double ns3::ThreeGppAntennaModel::GetHorizontalBeamwidth ( ) const

Get the horizontal beamwidth of the antenna element.

Returns
the horizontal beamwidth in degrees

Definition at line 68 of file three-gpp-antenna-model.cc.

References m_horizontalBeamwidthDegrees.

◆ GetMaxAttenuation()

double ns3::ThreeGppAntennaModel::GetMaxAttenuation ( ) const

Get the maximum attenuation of the antenna element.

Returns
the maximum attenuation in dB

Definition at line 123 of file three-gpp-antenna-model.cc.

References m_aMax.

◆ GetRadiationPattern()

ThreeGppAntennaModel::RadiationPattern ns3::ThreeGppAntennaModel::GetRadiationPattern ( ) const

Get the antenna radiation pattern.

Returns
the radiation pattern of the antenna

Definition at line 91 of file three-gpp-antenna-model.cc.

References m_radiationPattern.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetSlaV()

double ns3::ThreeGppAntennaModel::GetSlaV ( ) const

Get the side-lobe attenuation in the vertical direction of the antenna element.

Returns
side-lobe attenuation in the vertical direction in dB

Definition at line 117 of file three-gpp-antenna-model.cc.

References m_slaV.

◆ GetTypeId()

TypeId ns3::ThreeGppAntennaModel::GetTypeId ( )
static

Get the type ID.

Returns
The object TypeId.

Definition at line 25 of file three-gpp-antenna-model.cc.

References GetRadiationPattern(), INDOOR, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), OUTDOOR, ns3::TypeId::SetParent(), and SetRadiationPattern().

+ Here is the call graph for this function:

◆ GetVerticalBeamwidth()

double ns3::ThreeGppAntennaModel::GetVerticalBeamwidth ( ) const

Get the vertical beamwidth of the antenna element.

Returns
the vertical beamwidth in degrees

Definition at line 62 of file three-gpp-antenna-model.cc.

References m_verticalBeamwidthDegrees.

◆ SetIndoorAntennaPattern()

void ns3::ThreeGppAntennaModel::SetIndoorAntennaPattern ( )
private

Set the radiation pattern for Indoor Hotspot - eMBB, Table 8-7 in Report ITU-R M.2412.

Definition at line 107 of file three-gpp-antenna-model.cc.

References m_aMax, m_geMax, m_horizontalBeamwidthDegrees, m_slaV, and m_verticalBeamwidthDegrees.

Referenced by SetRadiationPattern().

+ Here is the caller graph for this function:

◆ SetOutdoorAntennaPattern()

void ns3::ThreeGppAntennaModel::SetOutdoorAntennaPattern ( )
private

Set the radiation pattern Dense Urban – eMBB, Rural – eMBB, Urban Macro – mMTC, and Urban Macro - URLLC, Table 8-6 in Report ITU-R M.2412.

Definition at line 97 of file three-gpp-antenna-model.cc.

References m_aMax, m_geMax, m_horizontalBeamwidthDegrees, m_slaV, and m_verticalBeamwidthDegrees.

Referenced by SetRadiationPattern().

+ Here is the caller graph for this function:

◆ SetRadiationPattern()

void ns3::ThreeGppAntennaModel::SetRadiationPattern ( RadiationPattern pattern)

Set the antenna radiation pattern.

Parameters
patternthe antenna radiation pattern to used

Definition at line 74 of file three-gpp-antenna-model.cc.

References INDOOR, m_radiationPattern, NS_ABORT_MSG, OUTDOOR, SetIndoorAntennaPattern(), and SetOutdoorAntennaPattern().

Referenced by ThreeGppAntennaModel(), DoInitialize(), and GetTypeId().

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

Member Data Documentation

◆ m_aMax

double ns3::ThreeGppAntennaModel::m_aMax
private

maximum attenuation (A_{max}) [dB]

Definition at line 108 of file three-gpp-antenna-model.h.

Referenced by GetGainDb(), GetMaxAttenuation(), SetIndoorAntennaPattern(), and SetOutdoorAntennaPattern().

◆ m_geMax

double ns3::ThreeGppAntennaModel::m_geMax
private

maximum directional gain of the antenna element (G_{E,max}) [dBi]

Definition at line 110 of file three-gpp-antenna-model.h.

Referenced by GetAntennaElementGain(), GetGainDb(), SetIndoorAntennaPattern(), and SetOutdoorAntennaPattern().

◆ m_horizontalBeamwidthDegrees

double ns3::ThreeGppAntennaModel::m_horizontalBeamwidthDegrees
private

beamwidth in the horizontal direction $(\phi_{3dB})$ [deg]

Definition at line 106 of file three-gpp-antenna-model.h.

Referenced by GetGainDb(), GetHorizontalBeamwidth(), SetIndoorAntennaPattern(), and SetOutdoorAntennaPattern().

◆ m_radiationPattern

RadiationPattern ns3::ThreeGppAntennaModel::m_radiationPattern
private

current antenna radiation pattern

Definition at line 111 of file three-gpp-antenna-model.h.

Referenced by DoInitialize(), GetRadiationPattern(), and SetRadiationPattern().

◆ m_slaV

double ns3::ThreeGppAntennaModel::m_slaV
private

side-lobe attenuation in the vertical direction (SLA_V) [dB]

Definition at line 109 of file three-gpp-antenna-model.h.

Referenced by GetGainDb(), GetSlaV(), SetIndoorAntennaPattern(), and SetOutdoorAntennaPattern().

◆ m_verticalBeamwidthDegrees

double ns3::ThreeGppAntennaModel::m_verticalBeamwidthDegrees
private

beamwidth in the vertical direction $(\theta_{3dB})$ [deg]

Definition at line 104 of file three-gpp-antenna-model.h.

Referenced by GetGainDb(), GetVerticalBeamwidth(), SetIndoorAntennaPattern(), and SetOutdoorAntennaPattern().


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