Cosine Antenna Model. More...
#include "cosine-antenna-model.h"
Public Member Functions | |
double | GetGainDb (Angles a) override |
this method is expected to be re-implemented by each antenna model | |
double | GetHorizontalBeamwidth () const |
Get the horizontal 3 dB beamwidth of the cosine antenna model. | |
double | GetOrientation () const |
Get the horizontal orientation of the antenna element. | |
double | GetVerticalBeamwidth () const |
Get the vertical 3 dB beamwidth of the cosine antenna model. | |
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 Member Functions | |
void | SetHorizontalBeamwidth (double horizontalBeamwidthDegrees) |
Set the horizontal 3 dB beamwidth (bilateral) of the cosine antenna model. | |
void | SetOrientation (double orientationDegrees) |
Set the horizontal orientation of the antenna element. | |
void | SetVerticalBeamwidth (double verticalBeamwidthDegrees) |
Set the vertical 3 dB beamwidth (bilateral) of the cosine antenna model. | |
Static Private Member Functions | |
static double | GetBeamwidthFromExponent (double exponent) |
Compute the beamwidth of the cosine antenna model from the exponent. | |
static double | GetExponentFromBeamwidth (double beamwidthDegrees) |
Compute the exponent of the cosine antenna model from the beamwidth. | |
Private Attributes | |
double | m_horizontalExponent |
exponent of the horizontal direction | |
double | m_maxGain |
antenna gain in dB towards the main orientation | |
double | m_orientationRadians |
orientation in radians in the horizontal direction (bearing) | |
double | m_verticalExponent |
exponent of the vertical direction | |
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. | |
Cosine Antenna Model.
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.
Definition at line 39 of file cosine-antenna-model.h.
Compute the beamwidth of the cosine antenna model from the exponent.
exponent | the exponent |
Definition at line 86 of file cosine-antenna-model.cc.
References NS_LOG_FUNCTION, and ns3::RadiansToDegrees().
Referenced by GetHorizontalBeamwidth(), and GetVerticalBeamwidth().
Compute the exponent of the cosine antenna model from the beamwidth.
beamwidthDegrees | the beamwidth in degrees |
Definition at line 63 of file cosine-antenna-model.cc.
References ns3::DegreesToRadians(), and NS_LOG_FUNCTION.
Referenced by SetHorizontalBeamwidth(), and SetVerticalBeamwidth().
this method is expected to be re-implemented by each antenna model
a | the spherical angles at which the radiation pattern should be evaluated |
Implements ns3::AntennaModel.
Definition at line 137 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().
double ns3::CosineAntennaModel::GetHorizontalBeamwidth | ( | ) | const |
Get the horizontal 3 dB beamwidth of the cosine antenna model.
Definition at line 118 of file cosine-antenna-model.cc.
References GetBeamwidthFromExponent(), and m_horizontalExponent.
Referenced by GetTypeId().
double ns3::CosineAntennaModel::GetOrientation | ( | ) | const |
Get the horizontal orientation of the antenna element.
Definition at line 131 of file cosine-antenna-model.cc.
References m_orientationRadians, and ns3::RadiansToDegrees().
Referenced by GetTypeId().
|
static |
Get the type ID.
Definition at line 26 of file cosine-antenna-model.cc.
References GetHorizontalBeamwidth(), GetOrientation(), GetVerticalBeamwidth(), m_maxGain, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), SetHorizontalBeamwidth(), SetOrientation(), ns3::TypeId::SetParent(), and SetVerticalBeamwidth().
double ns3::CosineAntennaModel::GetVerticalBeamwidth | ( | ) | const |
Get the vertical 3 dB beamwidth of the cosine antenna model.
Definition at line 112 of file cosine-antenna-model.cc.
References GetBeamwidthFromExponent(), and m_verticalExponent.
Referenced by GetTypeId().
|
private |
Set the horizontal 3 dB beamwidth (bilateral) of the cosine antenna model.
horizontalBeamwidthDegrees | the horizontal beamwidth in degrees |
Definition at line 105 of file cosine-antenna-model.cc.
References GetExponentFromBeamwidth(), m_horizontalExponent, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
private |
Set the horizontal orientation of the antenna element.
orientationDegrees | the horizontal orientation in degrees |
Definition at line 124 of file cosine-antenna-model.cc.
References ns3::DegreesToRadians(), m_orientationRadians, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
private |
Set the vertical 3 dB beamwidth (bilateral) of the cosine antenna model.
verticalBeamwidthDegrees | the vertical beamwidth in degrees |
Definition at line 98 of file cosine-antenna-model.cc.
References GetExponentFromBeamwidth(), m_verticalExponent, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
private |
exponent of the horizontal direction
Definition at line 103 of file cosine-antenna-model.h.
Referenced by GetGainDb(), GetHorizontalBeamwidth(), and SetHorizontalBeamwidth().
|
private |
antenna gain in dB towards the main orientation
Definition at line 105 of file cosine-antenna-model.h.
Referenced by GetGainDb(), and GetTypeId().
|
private |
orientation in radians in the horizontal direction (bearing)
Definition at line 104 of file cosine-antenna-model.h.
Referenced by GetGainDb(), GetOrientation(), and SetOrientation().
|
private |
exponent of the vertical direction
Definition at line 102 of file cosine-antenna-model.h.
Referenced by GetGainDb(), GetVerticalBeamwidth(), and SetVerticalBeamwidth().