ns-3
ns3::AntennaModel Class Reference

interface for antenna radiation pattern models More...

#include <antenna-model.h>

Inheritance diagram for ns3::AntennaModel:
Collaboration diagram for ns3::AntennaModel:

List of all members.

Public Member Functions

virtual double GetGainDb (Angles a)=0
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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 ()
 This method returns the TypeId associated to ns3::AntennaModel.

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
virtual void DoStart (void)
virtual void DoDispose (void)
 Object (const Object &o)

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


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

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

Referenced by ns3::SingleModelSpectrumChannel::StartTx(), and ns3::MultiModelSpectrumChannel::StartTx().

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

This method returns the TypeId associated to ns3::AntennaModel.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.

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

References ns3::TypeId::SetParent().


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