A Discrete-Event Network Simulator
API
ns3::CosineAntennaModel Class Reference

Cosine Antenna Model. More...

#include "cosine-antenna-model.h"

+ Inheritance diagram for ns3::CosineAntennaModel:
+ Collaboration diagram for ns3::CosineAntennaModel:

Public Member Functions

virtual double GetGainDb (Angles a)
 this method is expected to be re-implemented by each antenna model More...
 
double GetHorizontalBeamwidth (void) const
 Get the horizontal 3 dB beamwidth of the cosine antenna model. More...
 
double GetOrientation (void) const
 Get the horizontal orientation of the antenna element. More...
 
double GetVerticalBeamwidth (void) const
 Get the vertical 3 dB beamwidth of the cosine antenna model. More...
 
- Public Member Functions inherited from ns3::AntennaModel
 AntennaModel ()
 
virtual ~AntennaModel ()
 
- 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< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (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...
 
SimpleRefCountoperator= (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 ()
 
- Static Public Member Functions inherited from ns3::AntennaModel
static TypeId GetTypeId ()
 
- 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

void SetHorizontalBeamwidth (double horizontalBeamwidthDegrees)
 Set the horizontal 3 dB beamwidth (bilateral) of the cosine antenna model. More...
 
void SetOrientation (double orientationDegrees)
 Set the horizontal orientation of the antenna element. More...
 
void SetVerticalBeamwidth (double verticalBeamwidthDegrees)
 Set the vertical 3 dB beamwidth (bilateral) of the cosine antenna model. More...
 

Static Private Member Functions

static double GetBeamwidthFromExponent (double exponent)
 Compute the beamwidth of the cosine antenna model from the exponent. More...
 
static double GetExponentFromBeamwidth (double beamwidthDegrees)
 Compute the exponent of the cosine antenna model from the beamwidth. More...
 

Private Attributes

double m_horizontalExponent
 exponent of the horizontal direction More...
 
double m_maxGain
 antenna gain in dB towards the main orientation More...
 
double m_orientationRadians
 orientation in radians in the horizontal direction (bearing) More...
 
double m_verticalExponent
 exponent of the vertical direction 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...
 

Detailed Description

Cosine Antenna Model.


Introspection did not find any typical Config paths.

This class implements the cosine model, similarly to what is described in: Cosine Antenna Element, Mathworks, Phased Array System Toolbox (Sep. 2020) Available online: https://www.mathworks.com/help/phased/ug/cosine-antenna-element.html

The power pattern of the element is equal to: P(az,el) = cos(az/2)^2m * cos(pi/2 - incl/2)^2n, where az is the azimuth angle, and incl is the inclination angle.

Differently from the source, the response is defined for azimuth and elevation angles between –180 and 180 degrees and is always positive. There is no response at the backside of a cosine antenna. The cosine response pattern achieves a maximum value of 1 (0 dB) at 0 degrees azimuth and 90 degrees inclination. An extra settable gain is added to the original model, to improve its generality.


Attributes

  • VerticalBeamwidth: The 3 dB vertical beamwidth (degrees). A beamwidth of 360 deg corresponds to constant gain
    • Set with class: ns3::DoubleValue
    • Underlying type: double 0:360
    • Initial value: 360
    • Flags: construct write read
  • HorizontalBeamwidth: The 3 dB horizontal beamwidth (degrees). A beamwidth of 360 deg corresponds to constant gain
    • Set with class: ns3::DoubleValue
    • Underlying type: double 0:360
    • Initial value: 120
    • Flags: construct write read
  • Orientation: The angle (degrees) that expresses the orientation of the antenna on the x-y plane relative to the x axis
    • Set with class: ns3::DoubleValue
    • Underlying type: double -360:360
    • Initial value: 0
    • Flags: construct write read
  • MaxGain: The gain (dB) at the antenna boresight (the direction of maximum gain)
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0
    • Flags: construct write read

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

Definition at line 49 of file cosine-antenna-model.h.

Member Function Documentation

◆ GetBeamwidthFromExponent()

double ns3::CosineAntennaModel::GetBeamwidthFromExponent ( double  exponent)
staticprivate

Compute the beamwidth of the cosine antenna model from the exponent.

Parameters
exponentthe exponent
Returns
beamwidth in degrees

Definition at line 97 of file cosine-antenna-model.cc.

References NS_LOG_FUNCTION, and ns3::RadiansToDegrees().

Referenced by GetHorizontalBeamwidth(), and GetVerticalBeamwidth().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetExponentFromBeamwidth()

double ns3::CosineAntennaModel::GetExponentFromBeamwidth ( double  beamwidthDegrees)
staticprivate

Compute the exponent of the cosine antenna model from the beamwidth.

Parameters
beamwidthRadiansthe beamwidth in degrees
Returns
the exponent

Definition at line 73 of file cosine-antenna-model.cc.

References ns3::DegreesToRadians(), and NS_LOG_FUNCTION.

Referenced by SetHorizontalBeamwidth(), and SetVerticalBeamwidth().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetGainDb()

double ns3::CosineAntennaModel::GetGainDb ( Angles  a)
virtual

this method is expected to be re-implemented by each antenna model

Parameters
athe 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 155 of file cosine-antenna-model.cc.

References ns3::Angles::GetAzimuth(), ns3::Angles::GetInclination(), m_horizontalExponent, m_maxGain, m_orientationRadians, m_verticalExponent, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Angles::SetAzimuth().

Referenced by CosineAntennaModelTestCase::DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetHorizontalBeamwidth()

double ns3::CosineAntennaModel::GetHorizontalBeamwidth ( void  ) const

Get the horizontal 3 dB beamwidth of the cosine antenna model.

Returns
the horizontal beamwidth in degrees

Definition at line 133 of file cosine-antenna-model.cc.

References GetBeamwidthFromExponent(), and m_horizontalExponent.

Referenced by GetTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetOrientation()

double ns3::CosineAntennaModel::GetOrientation ( void  ) const

Get the horizontal orientation of the antenna element.

Returns
the horizontal orientation in degrees

Definition at line 148 of file cosine-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::CosineAntennaModel::GetTypeId ( void  )
static

◆ GetVerticalBeamwidth()

double ns3::CosineAntennaModel::GetVerticalBeamwidth ( void  ) const

Get the vertical 3 dB beamwidth of the cosine antenna model.

Returns
the vertical beamwidth in degrees

Definition at line 126 of file cosine-antenna-model.cc.

References GetBeamwidthFromExponent(), and m_verticalExponent.

Referenced by GetTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetHorizontalBeamwidth()

void ns3::CosineAntennaModel::SetHorizontalBeamwidth ( double  horizontalBeamwidthDegrees)
private

Set the horizontal 3 dB beamwidth (bilateral) of the cosine antenna model.

Parameters
horizontalBeamwidthDegreesthe horizontal beamwidth in degrees

Definition at line 118 of file cosine-antenna-model.cc.

References GetExponentFromBeamwidth(), m_horizontalExponent, 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::CosineAntennaModel::SetOrientation ( double  orientationDegrees)
private

Set the horizontal orientation of the antenna element.

Parameters
orientationDegreesthe horizontal orientation in degrees

Definition at line 140 of file cosine-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:

◆ SetVerticalBeamwidth()

void ns3::CosineAntennaModel::SetVerticalBeamwidth ( double  verticalBeamwidthDegrees)
private

Set the vertical 3 dB beamwidth (bilateral) of the cosine antenna model.

Parameters
verticalBeamwidthDegreesthe vertical beamwidth in degrees

Definition at line 110 of file cosine-antenna-model.cc.

References GetExponentFromBeamwidth(), m_verticalExponent, 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_horizontalExponent

double ns3::CosineAntennaModel::m_horizontalExponent
private

exponent of the horizontal direction

Definition at line 111 of file cosine-antenna-model.h.

Referenced by GetGainDb(), GetHorizontalBeamwidth(), and SetHorizontalBeamwidth().

◆ m_maxGain

double ns3::CosineAntennaModel::m_maxGain
private

antenna gain in dB towards the main orientation

Definition at line 113 of file cosine-antenna-model.h.

Referenced by GetGainDb(), and GetTypeId().

◆ m_orientationRadians

double ns3::CosineAntennaModel::m_orientationRadians
private

orientation in radians in the horizontal direction (bearing)

Definition at line 112 of file cosine-antenna-model.h.

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

◆ m_verticalExponent

double ns3::CosineAntennaModel::m_verticalExponent
private

exponent of the vertical direction

Definition at line 110 of file cosine-antenna-model.h.

Referenced by GetGainDb(), GetVerticalBeamwidth(), and SetVerticalBeamwidth().


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