ns-3
ns3::CosineAntennaModel Class Reference

Cosine Antenna Model. More...

#include <cosine-antenna-model.h>

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

List of all members.

Public Member Functions

virtual double GetGainDb (Angles a)
void SetBeamwidth (double beamwidthDegrees)
double GetBeamwidth () const
void SetOrientation (double orientationDegrees)
double GetOrientation () const

Static Public Member Functions

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

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


Member Function Documentation

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

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

Parameters:
thespherical 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.

References NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Angles::phi.

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.

References ns3::TypeId::SetParent().


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