antenna::SquareHorn Class Reference

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 327 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 336 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 356 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 363 of file antenna_factory.h.

{ return _dimension; }

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.

{ return _loss_factor; }

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

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

{ return _id; }

Referenced by 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 87 of file antenna_factory.h.

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

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

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

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