antenna::Isotropic Class Reference

Represents an isotropic antenna with uniform gain in all directions. More...

#include "antenna_factory.h"

Inheritance diagram for antenna::Isotropic:

Collaboration diagram for antenna::Isotropic:

Public Member Functions
	Isotropic (const std::string_view name, const SimId id=0)
	Constructs an Isotropic antenna with the given name.
	~Isotropic () override=default
	Isotropic (const Isotropic &)=delete
Isotropic &	operator= (const Isotropic &)=delete
	Isotropic (Isotropic &&)=delete
Isotropic &	operator= (Isotropic &&)=delete
RealType	getGain (const math::SVec3 &, const math::SVec3 &, RealType) const override
	Computes the gain of the isotropic antenna.
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

Represents an isotropic antenna with uniform gain in all directions.

This class models an ideal isotropic antenna, which has a directivity of 1 (0 dB).

Definition at line 140 of file antenna_factory.h.

Constructor & Destructor Documentation

Isotropic() [1/3]

antenna::Isotropic::Isotropic ( const std::string_view  name, const SimId  id = 0  )

explicit

Constructs an Isotropic antenna with the given name.

Parameters

name	The name of the antenna.

Definition at line 148 of file antenna_factory.h.

: Antenna(name.data(), id) {}

~Isotropic()

antenna::Isotropic::~Isotropic ( )

overridedefault

Isotropic() [2/3]

antenna::Isotropic::Isotropic ( const Isotropic &  )

delete

Isotropic() [3/3]

antenna::Isotropic::Isotropic ( Isotropic &&  )

delete

Member Function Documentation

getAngle()

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

staticprotectednoexceptinherited

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

noexceptinherited

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 getGain(), antenna::XmlAntenna::getGain(), antenna::H5Antenna::getGain(), and antenna::to_json().

Here is the caller graph for this function:

getGain()

RealType antenna::Isotropic::getGain ( const math::SVec3 &  , const math::SVec3 &  , RealType    ) const

overridevirtual

Computes the gain of the isotropic antenna.

Returns

The gain of the antenna, which is equal to the efficiency factor.

Implements antenna::Antenna.

Definition at line 165 of file antenna_factory.h.

        {
            // David Young: Isotropic antennas have a directivity of 1 (or 0 dB),
            // therefore, the gain of the antenna is the efficiency factor
            return getEfficiencyFactor();
        }

References antenna::Antenna::getEfficiencyFactor().

Here is the call graph for this function:

getId()

SimId antenna::Antenna::getId ( ) const

noexceptinherited

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

noexceptinherited

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

virtualnoexceptinherited

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]

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

delete

operator=() [2/2]

Isotropic & antenna::Isotropic::operator= ( Isotropic &&  )

delete

setEfficiencyFactor()

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

noexceptinherited

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 )

noexceptinherited

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 file:

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