Represents an antenna whose gain pattern is defined by an XML file. More...

#include "antenna_factory.h"

Inheritance diagram for antenna::XmlAntenna:

Collaboration diagram for antenna::XmlAntenna:

Public Types
enum class	AxisSymmetry : std::uint8_t { Mirrored , None }
	Symmetry mode for one-dimensional XML antenna gain axes. More...

Public Member Functions
	XmlAntenna (const std::string_view name, const std::string_view filename, const SimId id=0)
	Constructs an XmlAntenna with the specified name and XML configuration file.

	~XmlAntenna () override=default

	XmlAntenna (const XmlAntenna &)=delete

XmlAntenna &	operator= (const XmlAntenna &)=delete

	XmlAntenna (XmlAntenna &&)=delete

XmlAntenna &	operator= (XmlAntenna &&)=delete

RealType	getGain (const math::SVec3 &angle, const math::SVec3 &refangle, RealType wavelength) const override
	Computes the gain of the antenna based on the input angle and reference angle.

const std::string &	getFilename () const noexcept
	Gets the filename of the antenna description.

RealType	getMaxGain () const noexcept
	Gets the maximum gain of the antenna.

const interp::InterpSet *	getAzimuthSamples () const noexcept
	Gets the interpolation set for azimuth gain samples.

const interp::InterpSet *	getElevationSamples () const noexcept
	Gets the interpolation set for elevation gain samples.

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 antenna whose gain pattern is defined by an XML file.

This class models an antenna where the gain pattern is read from an XML file.

Definition at line 437 of file antenna_factory.h.

Member Enumeration Documentation

◆ AxisSymmetry

enum class antenna::XmlAntenna::AxisSymmetry : std::uint8_t

strong

Symmetry mode for one-dimensional XML antenna gain axes.

Enumerator
Mirrored	Mirror positive-axis samples onto negative angles.
None	Use the axis samples exactly as provided.

Definition at line 441 of file antenna_factory.h.

        {
            Mirrored, ///< Mirror positive-axis samples onto negative angles.
            None, ///< Use the axis samples exactly as provided.
        };

Constructor & Destructor Documentation

◆ XmlAntenna() [1/3]

antenna::XmlAntenna::XmlAntenna	(	const std::string_view	name,
		const std::string_view	filename,
		const SimId	id = `0`
	)

Constructs an XmlAntenna with the specified name and XML configuration file.

The constructor loads the azimuth and elevation gain patterns from the provided XML file.

Parameters

name	The name of the antenna.
filename	The path to the XML file containing the antenna's gain pattern data.

Definition at line 455 of file antenna_factory.h.

                                                                                                 :
            Antenna(name.data(), id), _azi_samples(std::make_unique<interp::InterpSet>()),
            _elev_samples(std::make_unique<interp::InterpSet>())
        {
            loadAntennaDescription(filename);
        }

◆ ~XmlAntenna()

antenna::XmlAntenna::~XmlAntenna ( )

overridedefault

◆ XmlAntenna() [2/3]

antenna::XmlAntenna::XmlAntenna ( const XmlAntenna & )

delete

◆ XmlAntenna() [3/3]

antenna::XmlAntenna::XmlAntenna ( XmlAntenna && )

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 356 of file antenna_factory.cpp.

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

References math::SVec3::length.

◆ getAzimuthSamples()

const interp::InterpSet * antenna::XmlAntenna::getAzimuthSamples ( ) const

noexcept

Gets the interpolation set for azimuth gain samples.

Definition at line 491 of file antenna_factory.h.

491{ return _azi_samples.get(); }

◆ getEfficiencyFactor()

RealType antenna::Antenna::getEfficiencyFactor ( ) const

noexceptinherited

Retrieves the efficiency factor of the antenna.

Returns: The efficiency factor of the antenna.

Definition at line 80 of file antenna_factory.h.

80{ return _loss_factor; }

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

Here is the caller graph for this function:

◆ getElevationSamples()

const interp::InterpSet * antenna::XmlAntenna::getElevationSamples ( ) const

noexcept

Gets the interpolation set for elevation gain samples.

Definition at line 494 of file antenna_factory.h.

494{ return _elev_samples.get(); }

◆ getFilename()

const std::string & antenna::XmlAntenna::getFilename ( ) const

noexcept

Gets the filename of the antenna description.

Definition at line 485 of file antenna_factory.h.

485{ return _filename; }

◆ getGain()

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

overridevirtual

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 (not used in this antenna type).

Returns: The gain of the antenna at the specified angle.

Exceptions

std::runtime_error If gain values cannot be retrieved from the interpolation sets.

Implements antenna::Antenna.

Definition at line 401 of file antenna_factory.cpp.

    {
        const SVec3 delta_angle = angle - refangle;
 
        const std::optional<RealType> azi_value =
            lookupAxisGain(_azi_samples.get(), delta_angle.azimuth, _azi_symmetry);
 
        if (const std::optional<RealType> elev_value =
                lookupAxisGain(_elev_samples.get(), delta_angle.elevation, _elev_symmetry);
            azi_value && elev_value)
        {
            return *azi_value * *elev_value * _max_gain * getEfficiencyFactor();
        }
 
        LOG(Level::FATAL, "Could not get antenna gain value");
        throw std::runtime_error("Could not get antenna gain value");
    }

References math::SVec3::azimuth, math::SVec3::elevation, antenna::Antenna::getEfficiencyFactor(), and LOG.

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 94 of file antenna_factory.h.

94{ return _id; }

Referenced by radar::to_json().

Here is the caller graph for this function:

◆ getMaxGain()

RealType antenna::XmlAntenna::getMaxGain ( ) const

noexcept

Gets the maximum gain of the antenna.

Definition at line 488 of file antenna_factory.h.

488{ return _max_gain; }

◆ getName()

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

noexceptinherited

Retrieves the name of the antenna.

Returns: The name of the antenna.

Definition at line 87 of file antenna_factory.h.

87{ return _name; }

◆ 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 103 of file antenna_factory.h.

103{ return 0; }

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

XmlAntenna & antenna::XmlAntenna::operator= ( XmlAntenna && )

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 347 of file antenna_factory.cpp.

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

References LOG.

◆ 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 117 of file antenna_factory.h.

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

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

Public Types

Public Member Functions

Static Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ AxisSymmetry

Constructor & Destructor Documentation

◆ XmlAntenna() [1/3]

◆ ~XmlAntenna()

◆ XmlAntenna() [2/3]

◆ XmlAntenna() [3/3]

Member Function Documentation

◆ getAngle()

◆ getAzimuthSamples()

◆ getEfficiencyFactor()

◆ getElevationSamples()

◆ getFilename()

◆ getGain()

◆ getId()

◆ getMaxGain()

◆ getName()

◆ getNoiseTemperature()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setEfficiencyFactor()

◆ setName()