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

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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

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)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. 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)

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Cosine Antenna Model.

Doxygen 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

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::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

a	the 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.

Referenced by CosineAntennaModelTestCase::DoRun().

Here is the caller graph for this function: