A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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

double GetBeamwidth () const
virtual double GetGainDb (Angles a)
double GetOrientation () const
void SetBeamwidth (double beamwidthDegrees)
void SetOrientation (double orientationDegrees)
- Public Member Functions inherited from ns3::AntennaModel
 AntennaModel ()
virtual ~AntennaModel ()
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
AggregateIterator GetAggregateIterator (void) const
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions

static TypeId GetTypeId ()
 This method returns the TypeId associated to ns3::CosineAntennaModel.

Private Attributes

double m_beamwidthRadians
double m_exponent
double m_maxGain
double m_orientationRadians

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoDispose (void)
virtual void DoStart (void)
virtual void NotifyNewAggregate (void)

Detailed Description

Cosine Antenna Model.

This class implements the cosine model as described in:

Li Chunjian, "Efficient Antenna Patterns for Three-Sector WCDMA Systems"

Note that only the element factor of the above model is considered. Also, an additional constant gain is added to model the radiation pattern on the vertical plane (to account for the fact that the elevation angle is not included in the model).

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

Member Function Documentation

double ns3::CosineAntennaModel::GetBeamwidth ( ) const

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

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 93 of file cosine-antenna-model.cc.

References m_exponent, m_maxGain, m_orientationRadians, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Angles::phi.

double ns3::CosineAntennaModel::GetOrientation ( ) const

Definition at line 87 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:

TypeId ns3::CosineAntennaModel::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::CosineAntennaModel.

Attributes defined for this type:

  • Beamwidth: The 3dB beamwidth (degrees)
    • Set with class: ns3::DoubleValue
    • Underlying type: double 0:180
    • Initial value: 60
    • 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 defined for this type.

Reimplemented from ns3::AntennaModel.

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

References GetBeamwidth(), GetOrientation(), m_maxGain, SetBeamwidth(), SetOrientation(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

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

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

Referenced by GetTypeId().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 80 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:

Member Data Documentation

double ns3::CosineAntennaModel::m_beamwidthRadians
private

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

Referenced by GetBeamwidth(), and SetBeamwidth().

double ns3::CosineAntennaModel::m_exponent
private

this is the variable "n" in the paper by Chunjian

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

Referenced by GetGainDb(), and SetBeamwidth().

double ns3::CosineAntennaModel::m_maxGain
private

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

Referenced by GetGainDb(), and GetTypeId().

double ns3::CosineAntennaModel::m_orientationRadians
private

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

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


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