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

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.

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

Related Symbols 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

Attributes

RadiationPattern: Radiation pattern of 3GPP antenna model
- Set with class: ns3::EnumValue<ns3::ThreeGppAntennaModel::RadiationPattern>
- Underlying type: Outdoor|Indoor
- Initial value: Outdoor
- Flags: constructwriteread
- Support level: SUPPORTED

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

enum class ns3::ThreeGppAntennaModel::RadiationPattern

strong

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

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