Class implementing the antenna model defined in 3GPP TR 38.901 V15.0.0. More...

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

Inheritance diagram for ns3::ThreeGppAntennaArrayModel:

Collaboration diagram for ns3::ThreeGppAntennaArrayModel:

Public Types
typedef std::vector< std::complex< double > >	ComplexVector
	type definition for complex vectors More...

Public Member Functions
	ThreeGppAntennaArrayModel (void)
	Constructor. More...

virtual	~ThreeGppAntennaArrayModel (void)
	Destructor. More...

void	ChangeToOmniTx (void)
	Change the antenna model to omnidirectional (ignoring the beams) More...

const ComplexVector &	GetBeamformingVector (void) const
	Returns the beamforming vector that is currently being used. More...

std::pair< double, double >	GetElementFieldPattern (Angles a) const
	Returns the horizontal and vertical components of the antenna element field pattern at the specified direction. More...

virtual Vector	GetElementLocation (uint64_t index) const
	Returns the location of the antenna element with the specified index assuming the left bottom corner is (0,0,0), normalized with respect to the wavelength. More...

virtual uint64_t	GetNumberOfElements (void) const
	Returns the number of antenna elements. More...

bool	IsOmniTx (void) const
	Returns true if the antenna is configured for omnidirectional transmissions. More...

void	SetBeamformingVector (const ComplexVector &beamformingVector)
	Sets the beamforming vector to be used. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject () const

template<>
Ptr< Object >	GetObject (TypeId tid) const

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator. 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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
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::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Member Functions
double	GetRadiationPattern (double vAngleRadian, double hAngleRadian) const
	Returns the radiation power pattern of a single antenna element in dB, generated according to Table 7.3-1 in 3GPP TR 38.901. More...

Private Attributes
double	m_alpha
	the bearing angle in radians More...

ComplexVector	m_beamformingVector
	the beamforming vector in use More...

double	m_beta
	the downtilt angle in radians More...

double	m_disH
	antenna spacing in the horizontal direction in multiples of wave length More...

double	m_disV
	antenna spacing in the vertical direction in multiples of wave length More...

double	m_gE
	directional gain of a single antenna element (dBi) More...

bool	m_isIsotropic
	if true, antenna elements are isotropic More...

bool	m_isOmniTx
	true if the antenna is configured for omni transmissions More...

uint32_t	m_numColumns
	number of columns More...

uint32_t	m_numRows
	number of rows More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

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

Detailed Description

Class implementing the antenna model defined in 3GPP TR 38.901 V15.0.0.

Introspection did not find any typical Config paths.

Note: the current implementation supports the modeling of antenna arrays composed of a single panel and with single (vertical) polarization.

Attributes

AntennaHorizontalSpacing: Horizontal spacing between antenna elements, in multiples of wave length
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.5
- Flags: construct write read
AntennaVerticalSpacing: Vertical spacing between antenna elements, in multiples of wave length
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.5
- Flags: construct write read
NumColumns: Horizontal size of the array
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 4
- Flags: construct write read
NumRows: Vertical size of the array
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 4
- Flags: construct write read
BearingAngle: The bearing angle in radians
- Set with class: ns3::DoubleValue
- Underlying type: double -3.14159:3.14159
- Initial value: 0
- Flags: construct write read
DowntiltAngle: The downtilt angle in radians
- Set with class: ns3::DoubleValue
- Underlying type: double 0:3.14159
- Initial value: 0
- Flags: construct write read
ElementGain: Directional gain of an antenna element in dBi
- Set with class: ns3::DoubleValue
- Underlying type: double 0:8
- Initial value: 4.97
- Flags: construct write read
IsotropicElements: If true, use an isotropic radiation pattern (for testing purposes)
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read

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

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

Member Typedef Documentation

◆ ComplexVector

typedef std::vector<std::complex<double> > ns3::ThreeGppAntennaArrayModel::ComplexVector

type definition for complex vectors

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

Constructor & Destructor Documentation

◆ ThreeGppAntennaArrayModel()

ns3::ThreeGppAntennaArrayModel::ThreeGppAntennaArrayModel ( void )

Constructor.

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

References m_isOmniTx, and NS_LOG_FUNCTION.

◆ ~ThreeGppAntennaArrayModel()

ns3::ThreeGppAntennaArrayModel::~ThreeGppAntennaArrayModel ( void )

virtual

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ChangeToOmniTx()

void ns3::ThreeGppAntennaArrayModel::ChangeToOmniTx ( void )

Change the antenna model to omnidirectional (ignoring the beams)

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

References m_isOmniTx, and NS_LOG_FUNCTION.

◆ GetBeamformingVector()

const ThreeGppAntennaArrayModel::ComplexVector & ns3::ThreeGppAntennaArrayModel::GetBeamformingVector ( void ) const

Returns the beamforming vector that is currently being used.

Returns: the current beamforming vector

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

References m_beamformingVector, and NS_LOG_FUNCTION.

Referenced by ThreeGppSpectrumPropagationLossModelTest::DoRun().

Here is the caller graph for this function:

◆ GetElementFieldPattern()

std::pair< double, double > ns3::ThreeGppAntennaArrayModel::GetElementFieldPattern ( Angles a ) const

Returns the horizontal and vertical components of the antenna element field pattern at the specified direction.

Only vertical polarization is considered.

Parameters

a	the angle indicating the interested direction

Returns: a pair in which the first element is the horizontal component of the field pattern and the second element is the vertical component of the field pattern

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

References GetRadiationPattern(), m_alpha, m_beta, NS_ASSERT_MSG(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Angles::phi, and ns3::Angles::theta.

Here is the call graph for this function:

◆ GetElementLocation()

Vector ns3::ThreeGppAntennaArrayModel::GetElementLocation ( uint64_t index ) const

virtual

Returns the location of the antenna element with the specified index assuming the left bottom corner is (0,0,0), normalized with respect to the wavelength.

Antenna elements are scanned row by row, left to right and bottom to top. For example, an antenna with 2 rows and 3 columns will be ordered as follows: ^ z | 3 4 5 | 0 1 2 -------—> y

Parameters

index index of the antenna element