A Discrete-Event Network Simulator
API
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)
 this method is expected to be re-implemented by each antenna model More...
 
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 ()
 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...
 
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 Attributes

double m_beamwidthRadians
 
double m_exponent
 this is the variable "n" in the paper by Chunjian More...
 
double m_maxGain
 
double m_orientationRadians
 

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


Attributes

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

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

Member Function Documentation

◆ GetBeamwidth()

double ns3::CosineAntennaModel::GetBeamwidth ( ) const

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

References m_beamwidthRadians, and ns3::RadiansToDegrees().

Referenced by GetTypeId().

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

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

Referenced by CosineAntennaModelTestCase::DoRun().

◆ GetOrientation()

double ns3::CosineAntennaModel::GetOrientation ( ) const

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

References m_orientationRadians, and ns3::RadiansToDegrees().

Referenced by GetTypeId().

◆ GetTypeId()

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

◆ SetBeamwidth()

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

◆ SetOrientation()

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

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

References ns3::DegreesToRadians(), m_orientationRadians, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Member Data Documentation

◆ m_beamwidthRadians

double ns3::CosineAntennaModel::m_beamwidthRadians
private

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

Referenced by GetBeamwidth(), and SetBeamwidth().

◆ m_exponent

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

◆ m_maxGain

double ns3::CosineAntennaModel::m_maxGain
private

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

Referenced by GetGainDb(), and GetTypeId().

◆ m_orientationRadians

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: