Represents a square horn antenna. More...

#include "antenna_factory.h"

Inheritance diagram for antenna::SquareHorn:

Collaboration diagram for antenna::SquareHorn:

Public Member Functions
	SquareHorn (const std::string_view name, const RealType dimension, const SimId id=0)
	Constructs a SquareHorn antenna with the given dimension.

	~SquareHorn () override=default

	SquareHorn (const SquareHorn &)=delete

SquareHorn &	operator= (const SquareHorn &)=delete

	SquareHorn (SquareHorn &&)=delete

SquareHorn &	operator= (SquareHorn &&)=delete

RealType	getGain (const math::SVec3 &angle, const math::SVec3 &refangle, RealType wavelength) const noexcept override
	Computes the gain of the square horn antenna.

RealType	getDimension () const noexcept
	Gets the dimension of the square horn.

void	setDimension (RealType dimension) noexcept
	Sets the dimension of the square horn.

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 a square horn antenna.

This antenna models a square horn with a specific dimension.

Definition at line 326 of file antenna_factory.h.

Constructor & Destructor Documentation

◆ SquareHorn() [1/3]

antenna::SquareHorn::SquareHorn	(	const std::string_view	name,
		const RealType	dimension,
		const SimId	id = `0`
	)

Constructs a SquareHorn antenna with the given dimension.

Parameters

name	The name of the antenna.
dimension	The dimension of the square horn.

Definition at line 335 of file antenna_factory.h.

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

◆ ~SquareHorn()

antenna::SquareHorn::~SquareHorn ( )

overridedefault

◆ SquareHorn() [2/3]

antenna::SquareHorn::SquareHorn ( const SquareHorn & )

delete

◆ SquareHorn() [3/3]

antenna::SquareHorn::SquareHorn ( SquareHorn && )

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.

◆ getDimension()

RealType antenna::SquareHorn::getDimension ( ) const

noexcept

Gets the dimension of the square horn.

Definition at line 362 of file antenna_factory.h.

362{ return _dimension; }

Referenced by serial::kml_generator_utils::findSquareHorn3DbDropAngle().

Here is the caller graph for this function:

◆ 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.

79{ 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()

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

overridevirtualnoexcept

Computes the gain of the square horn antenna.

Parameters

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

Returns: The computed gain of the antenna.

Implements antenna::Antenna.

Definition at line 346 of file antenna_factory.cpp.

    {
        const RealType ge = 4 * PI * std::pow(_dimension, 2) / std::pow(wavelength, 2);
        const RealType x = PI * _dimension * std::sin(getAngle(angle, refangle)) / wavelength;
        return ge * std::pow(sinc(x), 2) * getEfficiencyFactor();
    }

References PI.

◆ 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.

93{ 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.

86{ 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.

102{ return 0; }

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

SquareHorn & antenna::SquareHorn::operator= ( SquareHorn && )

delete

◆ setDimension()

void antenna::SquareHorn::setDimension ( RealType dimension )

noexcept

Sets the dimension of the square horn.

Parameters

dimension The new dimension of the square horn.

Definition at line 369 of file antenna_factory.h.

369{ _dimension = dimension; }

◆ 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.

116{ _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

Public Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SquareHorn() [1/3]

◆ ~SquareHorn()

◆ SquareHorn() [2/3]

◆ SquareHorn() [3/3]

Member Function Documentation

◆ getAngle()

◆ getDimension()

◆ getEfficiencyFactor()

◆ getGain()

◆ getId()

◆ getName()

◆ getNoiseTemperature()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setDimension()

◆ setEfficiencyFactor()

◆ setName()