antenna::Antenna Class Reference

Abstract base class representing an antenna. More...

#include "antenna_factory.h"

Inheritance diagram for antenna::Antenna:

Public Member Functions
	Antenna (std::string name, const SimId id=0) noexcept
	Constructs an Antenna object with the given name.
virtual	~Antenna ()=default
	Antenna (const Antenna &)=delete
Antenna &	operator= (const Antenna &)=delete
	Antenna (Antenna &&)=default
Antenna &	operator= (Antenna &&)=default
virtual RealType	getGain (const math::SVec3 &angle, const math::SVec3 &refangle, RealType wavelength) const =0
	Computes the gain of the antenna based on the input angle and reference angle.
RealType	getEfficiencyFactor () const noexcept
	Retrieves the efficiency factor of the antenna.
std::string	getName () const noexcept
	Retrieves the name of the antenna.
SimId	getId () const noexcept
	Retrieves the unique ID of the antenna.
virtual RealType	getNoiseTemperature (const math::SVec3 &) const noexcept
	Computes the noise temperature of the antenna based on the angle.
void	setEfficiencyFactor (RealType loss) noexcept
	Sets the efficiency factor of the antenna.
void	setName (std::string name) noexcept
	Sets the name of the antenna.

Static Protected Member Functions
static RealType	getAngle (const math::SVec3 &angle, const math::SVec3 &refangle) noexcept
	Computes the angle between the input and reference angles.

Detailed Description

Abstract base class representing an antenna.

Definition at line 39 of file antenna_factory.h.

Constructor & Destructor Documentation

Antenna() [1/3]

antenna::Antenna::Antenna ( std::string  name, const SimId  id = 0  )

explicitnoexcept

Constructs an Antenna object with the given name.

Parameters

name	The name of the antenna.

Definition at line 47 of file antenna_factory.h.

                                                                      :
            _loss_factor(1), _id(id == 0 ? SimIdGenerator::instance().generateId(ObjectType::Antenna) : id),
            _name(std::move(name))
        {
        }

~Antenna()

virtual antenna::Antenna::~Antenna ( )

virtualdefault

Antenna() [2/3]

antenna::Antenna::Antenna ( const Antenna &  )

delete

Antenna() [3/3]

antenna::Antenna::Antenna ( Antenna &&  )

default

Member Function Documentation

getAngle()

RealType antenna::Antenna::getAngle ( const math::SVec3 &  angle, const math::SVec3 &  refangle  )

staticprotectednoexcept

Computes the angle between the input and reference angles.

Parameters

angle	The input angle.
refangle	The reference angle.

Returns

The computed angle.

Definition at line 325 of file antenna_factory.cpp.

    {
        SVec3 normangle(angle);
        normangle.length = 1;
        return std::acos(dotProduct(Vec3(normangle), Vec3(refangle)));
    }

References math::SVec3::length.

getEfficiencyFactor()

RealType antenna::Antenna::getEfficiencyFactor ( ) const

noexcept

Retrieves the efficiency factor of the antenna.

Returns

The efficiency factor of the antenna.

Definition at line 79 of file antenna_factory.h.

{ return _loss_factor; }

Referenced by antenna::Isotropic::getGain(), antenna::XmlAntenna::getGain(), antenna::H5Antenna::getGain(), and antenna::to_json().

Here is the caller graph for this function:

getGain()

virtual RealType antenna::Antenna::getGain ( const math::SVec3 &  angle, const math::SVec3 &  refangle, RealType  wavelength  ) const

pure virtual

Computes the gain of the antenna based on the input angle and reference angle.

Parameters

angle	The angle at which the gain is to be computed.
refangle	The reference angle.
wavelength	The wavelength of the signal.

Returns

The gain of the antenna at the specified angle and wavelength.

Implemented in antenna::Isotropic, antenna::Sinc, antenna::Gaussian, antenna::SquareHorn, antenna::Parabolic, antenna::XmlAntenna, and antenna::H5Antenna.

Referenced by fers_get_antenna_pattern(), and radar::Radar::getGain().

Here is the caller graph for this function:

getId()

SimId antenna::Antenna::getId ( ) const

noexcept

Retrieves the unique ID of the antenna.

Returns

The antenna SimId.

Definition at line 93 of file antenna_factory.h.

{ return _id; }

Referenced by antenna::to_json(), radar::to_json(), and radar::to_json().

Here is the caller graph for this function:

getName()

std::string antenna::Antenna::getName ( ) const

noexcept

Retrieves the name of the antenna.

Returns

The name of the antenna.

Definition at line 86 of file antenna_factory.h.

{ return _name; }

Referenced by serial::kml_generator_utils::findGaussian3DbDropAngle(), serial::kml_generator_utils::findParabolic3DbDropAngle(), serial::kml_generator_utils::findSquareHorn3DbDropAngle(), serial::kml_generator_utils::generateAntennaKml(), serial::xml_serializer_utils::serializeMonostatic(), serial::xml_serializer_utils::serializeReceiver(), serial::xml_serializer_utils::serializeTransmitter(), and antenna::to_json().

Here is the caller graph for this function:

getNoiseTemperature()

virtual RealType antenna::Antenna::getNoiseTemperature ( const math::SVec3 &  ) const

virtualnoexcept

Computes the noise temperature of the antenna based on the angle.

Parameters

angle

The angle at which the noise temperature is to be computed.

Returns

The noise temperature of the antenna.

Definition at line 102 of file antenna_factory.h.

{ return 0; }

operator=() [1/2]

Antenna & antenna::Antenna::operator= ( Antenna &&  )

default

operator=() [2/2]

Antenna & antenna::Antenna::operator= ( const Antenna &  )

delete

setEfficiencyFactor()

void antenna::Antenna::setEfficiencyFactor ( RealType  loss )

noexcept

Sets the efficiency factor of the antenna.

Parameters

loss	The new efficiency factor.

Definition at line 316 of file antenna_factory.cpp.

    {
        if (loss > 1)
        {
            LOG(Level::INFO, "Using greater than unity antenna efficiency.");
        }
        _loss_factor = loss;
    }

References LOG.

Referenced by serial::update_antenna_from_json().

Here is the caller graph for this function:

setName()

void antenna::Antenna::setName ( std::string  name )

noexcept

Sets the name of the antenna.

Parameters

name	The new name of the antenna.

Definition at line 116 of file antenna_factory.h.

{ _name = std::move(name); }

Referenced by serial::update_antenna_from_json().

Here is the caller graph for this function:

---

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

• packages/libfers/src/antenna/antenna_factory.h
• packages/libfers/src/antenna/antenna_factory.cpp