A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::AntennaModel Class Referenceabstract

interface for antenna radiation pattern models More...

#include <antenna-model.h>

+ Inheritance diagram for ns3::AntennaModel:

Public Member Functions

virtual double GetGainDb (Angles a)=0
 
- 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
 
SimpleRefCountoperator= (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::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)
 

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

interface for antenna radiation pattern models

This class provides an interface for the definition of antenna radiation pattern models. This interface is based on the use of spherical coordinates, in particular of the azimuth and inclination angles. This choice is the one proposed "Antenna Theory - Analysis and Design", C.A. Balanis, Wiley, 2nd Ed., see in particular section 2.2 "Radiation pattern".

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 44 of file antenna-model.h.

Member Function Documentation

virtual double ns3::AntennaModel::GetGainDb ( Angles  a)
pure 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.

Implemented in ns3::ParabolicAntennaModel, ns3::CosineAntennaModel, and ns3::IsotropicAntennaModel.


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