A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::CosineAntennaModel Class Reference

Cosine Antenna Model. More...

#include <cosine-antenna-model.h>

+ Inheritance 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::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 Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::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 ()
 
- Static Public Member Functions inherited from ns3::AntennaModel
static TypeId GetTypeId ()
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

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 DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (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).

Doxygen introspection did not find any typical Config paths.

Attributes

  • 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 are defined for this type.

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

Member Function Documentation

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, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Angles::phi.

Member Data Documentation

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

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