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

#include "parabolic-antenna-model.h"

Inheritance diagram for ns3::ParabolicAntennaModel:

Collaboration diagram for ns3::ParabolicAntennaModel:

Public Member Functions
double	GetBeamwidth () const
	Get the Beam width.

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

double	GetOrientation () const
	Get the antenna orientation.

void	SetBeamwidth (double beamwidthDegrees)
	Set the Beam width.

void	SetOrientation (double orientationDegrees)
	Set the antenna orientation.

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

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 Attributes
double	m_beamwidthRadians
	Beam width in radians.

double	m_maxAttenuation
	Max attenuation.

double	m_orientationRadians
	Antenna orientation in radians.

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

This class implements the parabolic model as described in some 3GPP document, e.g., R4-092042

A similar model appears in:

George Calcev and Matt Dillon, "Antenna Tilt Control in CDMA Networks" in Proc. of the 2nd Annual International Wireless Internet Conference (WICON), 2006

though the latter addresses also the elevation plane, which the present model doesn't.

Definition at line 35 of file parabolic-antenna-model.h.

Member Function Documentation

◆ GetBeamwidth()

double ns3::ParabolicAntennaModel::GetBeamwidth ( ) const

Get the Beam width.

Returns: beam width in degrees

Definition at line 62 of file parabolic-antenna-model.cc.

References m_beamwidthRadians, and ns3::RadiansToDegrees().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetGainDb()

double ns3::ParabolicAntennaModel::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 81 of file parabolic-antenna-model.cc.

References ns3::Angles::GetAzimuth(), m_beamwidthRadians, m_maxAttenuation, m_orientationRadians, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ GetOrientation()

double ns3::ParabolicAntennaModel::GetOrientation ( ) const

Get the antenna orientation.

Returns: antenna orientation in degrees

Definition at line 75 of file parabolic-antenna-model.cc.

References m_orientationRadians, and ns3::RadiansToDegrees().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ParabolicAntennaModel::GetTypeId ( )

static

Get the type ID.

Returns: The object TypeId.

Definition at line 26 of file parabolic-antenna-model.cc.

References GetBeamwidth(), GetOrientation(), m_maxAttenuation, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), SetBeamwidth(), SetOrientation(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SetBeamwidth()

void ns3::ParabolicAntennaModel::SetBeamwidth ( double beamwidthDegrees )

Set the Beam width.

Parameters

beamwidthDegrees Beam width in degrees

Definition at line 55 of file parabolic-antenna-model.cc.

References ns3::DegreesToRadians(), m_beamwidthRadians, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetOrientation()

void ns3::ParabolicAntennaModel::SetOrientation ( double orientationDegrees )

Set the antenna orientation.

Parameters

orientationDegrees antenna orientation in degrees

Definition at line 68 of file parabolic-antenna-model.cc.

References ns3::DegreesToRadians(), m_orientationRadians, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_beamwidthRadians

double ns3::ParabolicAntennaModel::m_beamwidthRadians

private

Beam width in radians.

Definition at line 70 of file parabolic-antenna-model.h.

Referenced by GetBeamwidth(), GetGainDb(), and SetBeamwidth().

◆ m_maxAttenuation

double ns3::ParabolicAntennaModel::m_maxAttenuation

private

Max attenuation.

Definition at line 72 of file parabolic-antenna-model.h.

Referenced by GetGainDb(), and GetTypeId().

◆ m_orientationRadians

double ns3::ParabolicAntennaModel::m_orientationRadians

private

Antenna orientation in radians.

Definition at line 71 of file parabolic-antenna-model.h.

Referenced by GetGainDb(), GetOrientation(), and SetOrientation().

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

src/antenna/model/parabolic-antenna-model.h
src/antenna/model/parabolic-antenna-model.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetBeamwidth()

◆ GetGainDb()

◆ GetOrientation()

◆ GetTypeId()

◆ SetBeamwidth()

◆ SetOrientation()

Member Data Documentation

◆ m_beamwidthRadians

◆ m_maxAttenuation

◆ m_orientationRadians