A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::AntennaModel Class Referenceabstract

interface for antenna radiation pattern models More...

#include "antenna-model.h"

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

Public Member Functions

 AntennaModel ()
 
 ~AntennaModel () override
 
virtual double GetGainDb (Angles a)=0
 this method is expected to be re-implemented by each antenna model
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

interface for antenna radiation pattern models

Introspection did not find any typical Config paths.

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


No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Antenna

Size of this type is 56 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ AntennaModel()

ns3::AntennaModel::AntennaModel ( )

Definition at line 22 of file antenna-model.cc.

◆ ~AntennaModel()

ns3::AntennaModel::~AntennaModel ( )
override

Definition at line 26 of file antenna-model.cc.

Member Function Documentation

◆ GetGainDb()

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::CircularApertureAntennaModel, ns3::CosineAntennaModel, ns3::IsotropicAntennaModel, ns3::ParabolicAntennaModel, and ns3::ThreeGppAntennaModel.

◆ GetTypeId()

TypeId ns3::AntennaModel::GetTypeId ( )
static

Get the type ID.

Returns
The object TypeId.

Definition at line 31 of file antenna-model.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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