Class implementing Uniform Planar Array (UPA) model. More...

#include "uniform-planar-array.h"

Inheritance diagram for ns3::UniformPlanarArray:

Collaboration diagram for ns3::UniformPlanarArray:

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

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

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

Vector	GetElementLocation (uint64_t index) const override
	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...

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

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

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

Ptr< const AntennaModel >	GetAntennaElement (void) const
	Returns a pointer to the AntennaModel instance used to model the elements of the array. More...

ComplexVector	GetBeamformingVector (Angles a) const
	Returns the beamforming vector that points towards the specified position. More...

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

uint32_t	GetId () const
	Returns the ID of this antenna array instance. More...

ComplexVector	GetSteeringVector (Angles a) const
	Returns the steering vector that points toward the specified position. More...

void	SetAntennaElement (Ptr< AntennaModel > antennaElement)
	Sets the antenna model to be used. 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<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::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 (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

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

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[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= ([[maybe_unused]] 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)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::PhasedArrayModel
static TypeId	GetTypeId (void)
	Get the type ID. More...

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	GetAntennaHorizontalSpacing (void) const
	Get the horizontal spacing for the antenna elements of the phased array. More...

double	GetAntennaVerticalSpacing (void) const
	Get the vertical spacing for the antenna elements of the phased array. More...

uint32_t	GetNumColumns (void) const
	Get the number of columns of the phased array. More...

uint32_t	GetNumRows (void) const
	Get the number of rows of the phased array. More...

void	SetAlpha (double alpha)
	Set the bearing angle This method sets the bearing angle and computes its cosine and sine. More...

void	SetAntennaHorizontalSpacing (double s)
	Set the horizontal spacing for the antenna elements of the phased array This method resets the stored beamforming vector to a ComplexVector of the correct size, but zero-filled. More...

void	SetAntennaVerticalSpacing (double s)
	Set the vertical spacing for the antenna elements of the phased array This method resets the stored beamforming vector to a ComplexVector of the correct size, but zero-filled. More...

void	SetBeta (double beta)
	Set the downtilt angle This method sets the downtilt angle and computes its cosine and sine. More...

void	SetNumColumns (uint32_t n)
	Set the number of columns of the phased array This method resets the stored beamforming vector to a ComplexVector of the correct size, but zero-filled. More...

void	SetNumRows (uint32_t n)
	Set the number of rows of the phased array This method resets the stored beamforming vector to a ComplexVector of the correct size, but zero-filled. More...

void	SetPolSlant (double polSlant)
	Set the polarization slant angle This method sets the polarization slant angle and computes its cosine and sine. More...

Private Attributes
double	m_alpha {0.0}
	the bearing angle in radians More...

double	m_beta {0.0}
	the downtilt angle in radians More...

double	m_cosAlpha {1.0}
	the cosine of alpha More...

double	m_cosBeta {1.0}
	the cosine of Beta More...

double	m_cosPolSlant {1.0}
	the cosine of polarization slant angle More...

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

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

uint32_t	m_numColumns {1}
	number of columns More...

uint32_t	m_numRows {1}
	number of rows More...

double	m_polSlant {0.0}
	the polarization slant angle in radians More...

double	m_sinAlpha {0.0}
	the sine of alpha More...

double	m_sinBeta {0.0}
	the sine of Beta More...

double	m_sinPolSlant {0.0}
	the sine polarization slant angle More...

Additional Inherited Members
Public Types inherited from ns3::PhasedArrayModel
typedef std::vector< std::complex< double > >	ComplexVector
	type definition for complex vectors More...

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

Static Protected Member Functions inherited from ns3::PhasedArrayModel
static double	ComputeNorm (const ComplexVector &vector)
	Utility method to compute the euclidean norm of a ComplexVector. More...

Protected Attributes inherited from ns3::PhasedArrayModel
Ptr< AntennaModel >	m_antennaElement
	the model of the antenna element in use More...

ComplexVector	m_beamformingVector
	the beamforming vector in use More...

uint32_t	m_id {0}
	the ID of this antenna array instance More...

bool	m_isBfVectorValid
	ensures the validity of the beamforming vector More...

Static Protected Attributes inherited from ns3::PhasedArrayModel
static uint32_t	m_idCounter = 0
	the ID counter that is used to determine the unique antenna array ID 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 Uniform Planar Array (UPA) model.

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

Attributes

AntennaHorizontalSpacing: Horizontal spacing between antenna elements, in multiples of wave length
- Set with class: ns3::DoubleValue
- Underlying type: double 0: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 0: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 1:4294967295
- Initial value: 4
- Flags: construct write read
NumRows: Vertical size of the array
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 1: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
DowntiltAngle: The downtilt angle in radians
- Set with class: ns3::DoubleValue
- Underlying type: double -3.14159:3.14159
- Initial value: 0
- Flags: construct write
PolSlantAngle: The polarization slant angle in radians
- Set with class: ns3::DoubleValue
- Underlying type: double -3.14159:3.14159
- Initial value: 0
- Flags: construct write

Attributes defined in parent class ns3::PhasedArrayModel

AntennaElement: A pointer to the antenna element used by the phased array
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::AntennaModel>
- Initial value: 0x5621a67e6e40
- Flags: construct write read

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

Definition at line 38 of file uniform-planar-array.h.

Constructor & Destructor Documentation

◆ UniformPlanarArray()

ns3::UniformPlanarArray::UniformPlanarArray ( void )

Constructor.

Definition at line 34 of file uniform-planar-array.cc.

◆ ~UniformPlanarArray()

ns3::UniformPlanarArray::~UniformPlanarArray ( void )

virtual

Destructor.

Definition at line 38 of file uniform-planar-array.cc.

Member Function Documentation

◆ GetAntennaHorizontalSpacing()

double ns3::UniformPlanarArray::GetAntennaHorizontalSpacing ( void ) const

private

Get the horizontal spacing for the antenna elements of the phased array.

Returns: the horizontal spacing in multiples of wavelength

Definition at line 168 of file uniform-planar-array.cc.

References m_disH.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetAntennaVerticalSpacing()

double ns3::UniformPlanarArray::GetAntennaVerticalSpacing ( void ) const

private

Get the vertical spacing for the antenna elements of the phased array.

Returns: the vertical spacing in multiples of wavelength

Definition at line 189 of file uniform-planar-array.cc.

References m_disV.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetElementFieldPattern()

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

overridevirtual

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

Single 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

Implements ns3::PhasedArrayModel.

Definition at line 196 of file uniform-planar-array.cc.

References ns3::Angles::GetAzimuth(), ns3::AntennaModel::GetGainDb(), ns3::Angles::GetInclination(), m_alpha, ns3::PhasedArrayModel::m_antennaElement, m_cosBeta, m_cosPolSlant, m_sinBeta, m_sinPolSlant, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::RadiansToDegrees().

Here is the call graph for this function:

◆ GetElementLocation()

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

overridevirtual

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

Returns: the 3D vector that represents the position of the element

Implements ns3::PhasedArrayModel.

Definition at line 235 of file uniform-planar-array.cc.

References m_cosAlpha, m_cosBeta, m_disH, m_disV, m_numColumns, m_sinAlpha, m_sinBeta, and NS_LOG_FUNCTION.

◆ GetNumberOfElements()

uint64_t ns3::UniformPlanarArray::GetNumberOfElements ( void ) const

overridevirtual

Returns the number of antenna elements.

Returns: the number of antenna elements

Implements ns3::PhasedArrayModel.

Definition at line 255 of file uniform-planar-array.cc.

References m_numColumns, and m_numRows.

◆ GetNumColumns()

uint32_t ns3::UniformPlanarArray::GetNumColumns ( void ) const

private

Get the number of columns of the phased array.

Returns: the number of columns

Definition at line 105 of file uniform-planar-array.cc.

References m_numColumns.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetNumRows()

uint32_t ns3::UniformPlanarArray::GetNumRows ( void ) const

private

Get the number of rows of the phased array.

Returns: the number of rows

Definition at line 124 of file uniform-planar-array.cc.

References m_numRows.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::UniformPlanarArray::GetTypeId ( void )

static

Get the type ID.

Returns: The object TypeId.

Definition at line 42 of file uniform-planar-array.cc.

References GetAntennaHorizontalSpacing(), GetAntennaVerticalSpacing(), GetNumColumns(), GetNumRows(), ns3::MakeDoubleAccessor(), ns3::MakeUintegerAccessor(), SetAlpha(), SetAntennaHorizontalSpacing(), SetAntennaVerticalSpacing(), SetBeta(), SetNumColumns(), SetNumRows(), ns3::TypeId::SetParent(), and SetPolSlant().

Here is the call graph for this function:

◆ SetAlpha()

void ns3::UniformPlanarArray::SetAlpha ( double alpha )

private

Set the bearing angle This method sets the bearing angle and computes its cosine and sine.

Parameters

alpha the bearing angle in radians

Definition at line 130 of file uniform-planar-array.cc.

References sample-rng-plot::alpha, m_alpha, m_cosAlpha, and m_sinAlpha.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetAntennaHorizontalSpacing()

void ns3::UniformPlanarArray::SetAntennaHorizontalSpacing ( double s )

private

Set the horizontal spacing for the antenna elements of the phased array This method resets the stored beamforming vector to a ComplexVector of the correct size, but zero-filled.

Parameters

s	the horizontal spacing in multiples of wavelength

Definition at line 154 of file uniform-planar-array.cc.

References m_disH, ns3::PhasedArrayModel::m_isBfVectorValid, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetAntennaVerticalSpacing()

void ns3::UniformPlanarArray::SetAntennaVerticalSpacing ( double s )

private

Set the vertical spacing for the antenna elements of the phased array This method resets the stored beamforming vector to a ComplexVector of the correct size, but zero-filled.

Parameters

s	the vertical spacing in multiples of wavelength

Definition at line 175 of file uniform-planar-array.cc.

References m_disV, ns3::PhasedArrayModel::m_isBfVectorValid, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetBeta()

void ns3::UniformPlanarArray::SetBeta ( double beta )

private

Set the downtilt angle This method sets the downtilt angle and computes its cosine and sine.

Parameters

beta	the downtilt angle in radians

Definition at line 138 of file uniform-planar-array.cc.

References m_beta, m_cosBeta, and m_sinBeta.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetNumColumns()

void ns3::UniformPlanarArray::SetNumColumns ( uint32_t n )

private

Set the number of columns of the phased array This method resets the stored beamforming vector to a ComplexVector of the correct size, but zero-filled.

Parameters

n	the number of columns

Definition at line 93 of file uniform-planar-array.cc.

References ns3::PhasedArrayModel::m_isBfVectorValid, m_numColumns, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetNumRows()

void ns3::UniformPlanarArray::SetNumRows ( uint32_t n )

private

Set the number of rows of the phased array This method resets the stored beamforming vector to a ComplexVector of the correct size, but zero-filled.

Parameters

n	the number of rows

Definition at line 112 of file uniform-planar-array.cc.

References ns3::PhasedArrayModel::m_isBfVectorValid, m_numRows, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetPolSlant()

void ns3::UniformPlanarArray::SetPolSlant ( double polSlant )

private

Set the polarization slant angle This method sets the polarization slant angle and computes its cosine and sine.

Parameters

polSlant the polarization slant angle in radians

Definition at line 146 of file uniform-planar-array.cc.

References m_cosPolSlant, m_polSlant, and m_sinPolSlant.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_alpha

double ns3::UniformPlanarArray::m_alpha {0.0}

private

the bearing angle in radians

Definition at line 183 of file uniform-planar-array.h.

Referenced by GetElementFieldPattern(), and SetAlpha().

◆ m_beta

double ns3::UniformPlanarArray::m_beta {0.0}

private

the downtilt angle in radians

Definition at line 186 of file uniform-planar-array.h.

Referenced by SetBeta().

◆ m_cosAlpha

double ns3::UniformPlanarArray::m_cosAlpha {1.0}

private

the cosine of alpha

Definition at line 184 of file uniform-planar-array.h.

Referenced by GetElementLocation(), and SetAlpha().

◆ m_cosBeta

double ns3::UniformPlanarArray::m_cosBeta {1.0}

private

the cosine of Beta

Definition at line 187 of file uniform-planar-array.h.

Referenced by GetElementFieldPattern(), GetElementLocation(), and SetBeta().

◆ m_cosPolSlant

double ns3::UniformPlanarArray::m_cosPolSlant {1.0}

private

the cosine of polarization slant angle

Definition at line 190 of file uniform-planar-array.h.

Referenced by GetElementFieldPattern(), and SetPolSlant().

◆ m_disH

double ns3::UniformPlanarArray::m_disH {0.5}

private

antenna spacing in the horizontal direction in multiples of wave length

Definition at line 182 of file uniform-planar-array.h.

Referenced by GetAntennaHorizontalSpacing(), GetElementLocation(), and SetAntennaHorizontalSpacing().

◆ m_disV

double ns3::UniformPlanarArray::m_disV {0.5}

private

antenna spacing in the vertical direction in multiples of wave length

Definition at line 181 of file uniform-planar-array.h.

Referenced by GetAntennaVerticalSpacing(), GetElementLocation(), and SetAntennaVerticalSpacing().

◆ m_numColumns

uint32_t ns3::UniformPlanarArray::m_numColumns {1}

private

number of columns

Definition at line 179 of file uniform-planar-array.h.

Referenced by GetElementLocation(), GetNumberOfElements(), GetNumColumns(), and SetNumColumns().

◆ m_numRows

uint32_t ns3::UniformPlanarArray::m_numRows {1}

private

number of rows

Definition at line 180 of file uniform-planar-array.h.

Referenced by GetNumberOfElements(), GetNumRows(), and SetNumRows().

◆ m_polSlant

double ns3::UniformPlanarArray::m_polSlant {0.0}

private

the polarization slant angle in radians

Definition at line 189 of file uniform-planar-array.h.

Referenced by SetPolSlant().

◆ m_sinAlpha

double ns3::UniformPlanarArray::m_sinAlpha {0.0}

private

the sine of alpha

Definition at line 185 of file uniform-planar-array.h.

Referenced by GetElementLocation(), and SetAlpha().

◆ m_sinBeta

double ns3::UniformPlanarArray::m_sinBeta {0.0}

private

the sine of Beta

Definition at line 188 of file uniform-planar-array.h.

Referenced by GetElementFieldPattern(), GetElementLocation(), and SetBeta().

◆ m_sinPolSlant

double ns3::UniformPlanarArray::m_sinPolSlant {0.0}

private

the sine polarization slant angle

Definition at line 191 of file uniform-planar-array.h.

Referenced by GetElementFieldPattern(), and SetPolSlant().

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

src/antenna/model/uniform-planar-array.h
src/antenna/model/uniform-planar-array.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Attributes defined in parent class ns3::PhasedArrayModel

Constructor & Destructor Documentation

◆ UniformPlanarArray()

◆ ~UniformPlanarArray()

Member Function Documentation

◆ GetAntennaHorizontalSpacing()

◆ GetAntennaVerticalSpacing()

◆ GetElementFieldPattern()

◆ GetElementLocation()

◆ GetNumberOfElements()

◆ GetNumColumns()

◆ GetNumRows()

◆ GetTypeId()

◆ SetAlpha()

◆ SetAntennaHorizontalSpacing()

◆ SetAntennaVerticalSpacing()

◆ SetBeta()

◆ SetNumColumns()

◆ SetNumRows()

◆ SetPolSlant()

Member Data Documentation

◆ m_alpha

◆ m_beta

◆ m_cosAlpha

◆ m_cosBeta

◆ m_cosPolSlant

◆ m_disH

◆ m_disV

◆ m_numColumns

◆ m_numRows

◆ m_polSlant

◆ m_sinAlpha

◆ m_sinBeta

◆ m_sinPolSlant