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 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.

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.

Public Member Functions inherited from ns3::AntennaModel
	AntennaModel ()

	~AntennaModel () override

virtual double	GetGainDb (Angles a)=0
	this method is expected to be re-implemented by each antenna model

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 override
	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< Object >	GetObject () 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< Object >	GetObject (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.

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.

SimpleRefCount &	operator= (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) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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 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]

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	DoInitialize ()
	Initialize() 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.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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

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

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

Constructor & Destructor Documentation

◆ ThreeGppAntennaModel()

ns3::ThreeGppAntennaModel::ThreeGppAntennaModel ( )

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

◆ ~ThreeGppAntennaModel()

ns3::ThreeGppAntennaModel::~ThreeGppAntennaModel ( )

override

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

Member Function Documentation

◆ 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 82 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

a	the 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 88 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 64 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 76 of file three-gpp-antenna-model.cc.

References m_aMax.

◆ 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 70 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 35 of file three-gpp-antenna-model.cc.

References ns3::TypeId::SetParent().

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 58 of file three-gpp-antenna-model.cc.

References m_verticalBeamwidthDegrees.

Member Data Documentation

◆ m_aMax

double ns3::ThreeGppAntennaModel::m_aMax

private

maximum attenuation (A_{max}) [dB]

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

Referenced by GetGainDb(), and GetMaxAttenuation().

◆ m_geMax

double ns3::ThreeGppAntennaModel::m_geMax

private

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

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

Referenced by GetAntennaElementGain(), and GetGainDb().

◆ m_horizontalBeamwidthDegrees

double ns3::ThreeGppAntennaModel::m_horizontalBeamwidthDegrees

private

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

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

Referenced by GetGainDb(), and GetHorizontalBeamwidth().

◆ m_slaV

double ns3::ThreeGppAntennaModel::m_slaV

private

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

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

Referenced by GetGainDb(), and GetSlaV().

◆ m_verticalBeamwidthDegrees

double ns3::ThreeGppAntennaModel::m_verticalBeamwidthDegrees

private

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

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

Referenced by GetGainDb(), and GetVerticalBeamwidth().

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

src/antenna/model/three-gpp-antenna-model.h
src/antenna/model/three-gpp-antenna-model.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ThreeGppAntennaModel()

◆ ~ThreeGppAntennaModel()

Member Function Documentation

◆ GetAntennaElementGain()

◆ GetGainDb()

◆ GetHorizontalBeamwidth()

◆ GetMaxAttenuation()

◆ GetSlaV()

◆ GetTypeId()

◆ GetVerticalBeamwidth()

Member Data Documentation

◆ m_aMax

◆ m_geMax

◆ m_horizontalBeamwidthDegrees

◆ m_slaV

◆ m_verticalBeamwidthDegrees