inet::physicallayer::CosineAntenna Class Reference

#include <CosineAntenna.h>

Inheritance diagram for inet::physicallayer::CosineAntenna:

Public Member Functions
	CosineAntenna ()
virtual std::ostream &	printToStream (std::ostream &stream, int level) const override
	Prints this object to the provided output stream. More...
virtual double	getMaxGain () const override
	Returns the maximum possible antenna gain independent of any direction. More...
virtual double	computeGain (const EulerAngles direction) const override
	Returns the antenna gain in the provided direction. More...
Public Member Functions inherited from inet::physicallayer::AntennaBase
	AntennaBase ()
virtual IMobility *	getMobility () const override
	Returns the mobility of this antenna that describes its position and orientation over time. More...
virtual int	getNumAntennas () const override
	Returns the number of antennas in the array. More...
Public Member Functions inherited from inet::physicallayer::IPrintableObject
virtual	~IPrintableObject ()
virtual std::string	getInfoStringRepresentation () const
virtual std::string	getDetailStringRepresentation () const
virtual std::string	getDebugStringRepresentation () const
virtual std::string	getTraceStringRepresentation () const
virtual std::string	getCompleteStringRepresentation () const

Protected Member Functions
virtual void	initialize (int stage) override

Protected Attributes
double	maxGain
degree	beamWidth
Protected Attributes inherited from inet::physicallayer::AntennaBase
IMobility *	mobility
int	numAntennas

Additional Inherited Members
Public Types inherited from inet::physicallayer::IPrintableObject
enum	PrintLevel {   PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,   PRINT_LEVEL_COMPLETE = INT_MIN }

Constructor & Destructor Documentation

inet::physicallayer::CosineAntenna::CosineAntenna

(

)

                             :
    AntennaBase(),
    maxGain(NaN),
    beamWidth(NaN)
{
}

Member Function Documentation

double inet::physicallayer::CosineAntenna::computeGain ( const EulerAngles  direction ) const

overridevirtual

Returns the antenna gain in the provided direction.

The direction is relative to the antenna geometry, so the result depends only on the antenna characteristics. For transmissions, it determines how well the antenna converts input power into radio waves headed in the specified direction. For receptions, it determines how well the antenna converts radio waves arriving from the the specified direction.

Implements inet::physicallayer::IAntenna.

{
    double exponent = -3.0 / (20 * std::log10(std::cos(math::deg2rad(beamWidth.get()) / 4.0)));
    return maxGain * std::pow(std::cos(direction.alpha / 2.0), exponent);
}

virtual double inet::physicallayer::CosineAntenna::getMaxGain ( ) const

inlineoverridevirtual

Returns the maximum possible antenna gain independent of any direction.

Implements inet::physicallayer::IAntenna.

{ return maxGain; }

void inet::physicallayer::CosineAntenna::initialize ( int  stage )

overrideprotectedvirtual

Reimplemented from inet::physicallayer::AntennaBase.

{
    AntennaBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        maxGain = math::dB2fraction(par("maxGain"));
        beamWidth = degree(par("beamWidth"));
    }
}

std::ostream & inet::physicallayer::CosineAntenna::printToStream ( std::ostream &  stream, int  level  ) const

overridevirtual

Prints this object to the provided output stream.

Function calls to operator<< with pointers or references either const or not are all forwarded to this function.

Reimplemented from inet::physicallayer::AntennaBase.

{
    stream << "CosineAntenna";
    if (level <= PRINT_LEVEL_DETAIL)
        stream << ", maxGain = " << maxGain
               << ", beamWidth = " << beamWidth;
    return AntennaBase::printToStream(stream, level);
}

Member Data Documentation

degree inet::physicallayer::CosineAntenna::beamWidth

protected

Referenced by computeGain(), initialize(), and printToStream().

double inet::physicallayer::CosineAntenna::maxGain

protected

Referenced by computeGain(), initialize(), and printToStream().

---

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

• CosineAntenna.h
• CosineAntenna.cc