Isotropic antenna model. More...

#include "isotropic-antenna-model.h"

Inheritance diagram for ns3::IsotropicAntennaModel:

Collaboration diagram for ns3::IsotropicAntennaModel:

Public Member Functions
	IsotropicAntennaModel ()

double	GetGainDb (Angles a) override
	this method is expected to be re-implemented by each antenna model

Public Member Functions inherited from ns3::AntennaModel
	AntennaModel ()

	~AntennaModel () override

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

SimpleRefCount &	operator= (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::AntennaModel
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.

Protected Attributes
double	m_gainDb
	gain of the antenna in dB, in all directions

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.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Isotropic antenna model.

Introspection did not find any typical Config paths.

This is the simplest antenna model. The gain of this antenna is the same in all directions.

Attributes

Gain: The gain of the antenna in dB
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: constructwriteread
- Support level: SUPPORTED

No TraceSources are defined for this type.
Group: Antenna

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

Definition at line 26 of file isotropic-antenna-model.h.

Constructor & Destructor Documentation

◆ IsotropicAntennaModel()

ns3::IsotropicAntennaModel::IsotropicAntennaModel ( )

Definition at line 38 of file isotropic-antenna-model.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetGainDb()

double ns3::IsotropicAntennaModel::GetGainDb ( Angles a )

overridevirtual

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 44 of file isotropic-antenna-model.cc.

References m_gainDb, and NS_LOG_FUNCTION.