inet::physicallayer::AxiallySymmetricAntenna::AntennaGain Class Reference

#include <AxiallySymmetricAntenna.h>

Inheritance diagram for inet::physicallayer::AxiallySymmetricAntenna::AntennaGain:

Public Member Functions
	AntennaGain (const char *axis, double baseGain, const char *gains)
virtual double	getMinGain () const override
	Returns the minimum possible antenna gain independent of any direction. More...
virtual double	getMaxGain () const override
	Returns the maximum possible antenna gain independent of any direction. More...
virtual double	computeGain (const Quaternion &direction) const override
	Returns the antenna gain in the provided direction. More...
Public Member Functions inherited from inet::IPrintableObject
virtual	~IPrintableObject ()
virtual std::ostream &	printToStream (std::ostream &stream, int level, int evFlags=0) const
	Prints this object to the provided output stream. More...
virtual std::string	printToString () const
virtual std::string	printToString (int level, int evFlags=0) const
virtual std::string	getInfoStringRepresentation (int evFlags=0) const
virtual std::string	getDetailStringRepresentation (int evFlags=0) const
virtual std::string	getDebugStringRepresentation (int evFlags=0) const
virtual std::string	getTraceStringRepresentation (int evFlags=0) const
virtual std::string	getCompleteStringRepresentation (int evFlags=0) const
Public Member Functions inherited from inet::IntrusivePtrCounter< IAntennaGain >
INET_ALWAYS_INLINE	IntrusivePtrCounter () noexcept
INET_ALWAYS_INLINE	IntrusivePtrCounter (IntrusivePtrCounter const &) noexcept
INET_ALWAYS_INLINE unsigned int	use_count () const noexcept
INET_ALWAYS_INLINE IntrusivePtrCounter &	operator= (IntrusivePtrCounter const &) noexcept
INET_ALWAYS_INLINE IntrusivePtr< IAntennaGain >	shared_from_this ()

Protected Attributes
double	minGain = NaN
double	maxGain = NaN
Coord	axisOfSymmetryDirection = Coord::NIL
std::map< rad, double >	gainMap

Additional Inherited Members
Public Types inherited from inet::IPrintableObject
enum	PrintLevel {   PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,   PRINT_LEVEL_COMPLETE = INT_MIN }
enum	PrintFlag { PRINT_FLAG_FORMATTED = (1 << 0), PRINT_FLAG_MULTILINE = (1 << 1) }
Protected Member Functions inherited from inet::IntrusivePtrCounter< IAntennaGain >
INET_ALWAYS_INLINE	~IntrusivePtrCounter ()=default

Constructor & Destructor Documentation

AntennaGain()

inet::physicallayer::AxiallySymmetricAntenna::AntennaGain::AntennaGain	(	const char *	axis,
		double	baseGain,
		const char *	gains
	)

                                                                                                    :
    minGain(NaN),
    maxGain(NaN)
{
    axisOfSymmetryDirection = Coord::parse(axis);
    cStringTokenizer tokenizer(gains);
    while (tokenizer.hasMoreTokens()) {
        const char *angleString = tokenizer.nextToken();
        const char *gainString = tokenizer.nextToken();
        if (!angleString || !gainString)
            throw cRuntimeError("Insufficient number of values");
        auto angle = deg(atof(angleString));
        double gain = baseGain * math::dB2fraction(atof(gainString));
        if (std::isnan(minGain) || gain < minGain)
            minGain = gain;
        if (std::isnan(maxGain) || gain > maxGain)
            maxGain = gain;
        gainMap.insert(std::pair<rad, double>(angle, gain));
    }
    if (!containsKey(gainMap, deg(0)))
        throw cRuntimeError("The first angle must be 0");
    if (!containsKey(gainMap, deg(180)))
        throw cRuntimeError("The last angle must be 180");
}

Member Function Documentation

computeGain()

double inet::physicallayer::AxiallySymmetricAntenna::AntennaGain::computeGain ( const Quaternion &  direction ) const

overridevirtual

Returns the antenna gain in the provided direction.

The direction is determined by rotating the X axis using the given quaternion. The direction is to be interpreted in the local coordinate system of the radiation pattern. This way the gain depends only on the antenna radion pattern characteristics, and not on the antenna orientation determined by the antenna's mobility model.

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 specified direction.

Implements inet::physicallayer::IAntennaGain.

{
    double product = math::minnan(1.0, math::maxnan(-1.0, direction.rotate(Coord::X_AXIS) * Coord::X_AXIS));
    rad angle = rad(std::acos(product));
    // NOTE: 0 and M_PI are always in the map
    std::map<rad, double>::const_iterator lowerBound = gainMap.lower_bound(angle);
    std::map<rad, double>::const_iterator upperBound = gainMap.upper_bound(angle);
    if (lowerBound->first != angle)
        lowerBound--;
    if (upperBound == gainMap.end())
        upperBound--;
    if (upperBound == lowerBound)
        return lowerBound->second;
    else {
        auto lowerAngle = lowerBound->first;
        auto upperAngle = upperBound->first;
        double lowerGain = lowerBound->second;
        double upperGain = upperBound->second;
        double alpha = unit((angle - lowerAngle) / (upperAngle - lowerAngle)).get();
        double gain = (1 - alpha) * lowerGain + alpha * upperGain;
        ASSERT(!std::isnan(gain));
        return gain;
    }
}

getMaxGain()

virtual double inet::physicallayer::AxiallySymmetricAntenna::AntennaGain::getMaxGain ( ) const

inlineoverridevirtual

Returns the maximum possible antenna gain independent of any direction.

Implements inet::physicallayer::IAntennaGain.

{ return maxGain; }

getMinGain()

virtual double inet::physicallayer::AxiallySymmetricAntenna::AntennaGain::getMinGain ( ) const

inlineoverridevirtual

Returns the minimum possible antenna gain independent of any direction.

Implements inet::physicallayer::IAntennaGain.

{ return minGain; }

Member Data Documentation

axisOfSymmetryDirection

Coord inet::physicallayer::AxiallySymmetricAntenna::AntennaGain::axisOfSymmetryDirection = Coord::NIL

protected

Referenced by AntennaGain().

gainMap

std::map<rad, double> inet::physicallayer::AxiallySymmetricAntenna::AntennaGain::gainMap

protected

Referenced by AntennaGain().

maxGain

double inet::physicallayer::AxiallySymmetricAntenna::AntennaGain::maxGain = NaN

protected

Referenced by AntennaGain().

minGain

double inet::physicallayer::AxiallySymmetricAntenna::AntennaGain::minGain = NaN

protected

Referenced by AntennaGain().

---

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

• AxiallySymmetricAntenna.h
• AxiallySymmetricAntenna.cc