antenna::Parabolic Class Reference

Represents a parabolic reflector antenna. More...

#include "antenna_factory.h"

Inheritance diagram for antenna::Parabolic:

Collaboration diagram for antenna::Parabolic:

Public Member Functions
	Parabolic (const std::string_view name, const RealType diameter)
	Constructs a Parabolic antenna with the given diameter.
	~Parabolic () override=default
	Parabolic (const Parabolic &)=delete
Parabolic &	operator= (const Parabolic &)=delete
	Parabolic (Parabolic &&)=delete
Parabolic &	operator= (Parabolic &&)=delete
RealType	getGain (const math::SVec3 &angle, const math::SVec3 &refangle, RealType wavelength) const noexcept override
	Computes the gain of the parabolic antenna.
RealType	getDiameter () const noexcept
	Gets the diameter of the parabolic reflector.
RealType	getEfficiencyFactor () const noexcept
	Retrieves the efficiency factor of the antenna.
std::string	getName () const noexcept
	Retrieves the name 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.

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 parabolic reflector antenna.

This antenna models a parabolic reflector with a specific diameter.

Definition at line 317 of file antenna_factory.h.

Constructor & Destructor Documentation

Parabolic() [1/3]

antenna::Parabolic::Parabolic	(	const std::string_view	name,
		const RealType	diameter
	)

Constructs a Parabolic antenna with the given diameter.

Parameters

name	The name of the antenna.
diameter	The diameter of the parabolic reflector.

Definition at line 326 of file antenna_factory.h.

: Antenna(name.data()), _diameter(diameter) {}

~Parabolic()

antenna::Parabolic::~Parabolic ( )

overridedefault

Parabolic() [2/3]

antenna::Parabolic::Parabolic ( const Parabolic &  )

delete

Parabolic() [3/3]

antenna::Parabolic::Parabolic ( Parabolic &&  )

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

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

References math::SVec3::length.

getDiameter()

RealType antenna::Parabolic::getDiameter ( ) const

noexcept

Gets the diameter of the parabolic reflector.

Definition at line 350 of file antenna_factory.h.

{ return _diameter; }

getEfficiencyFactor()

RealType antenna::Antenna::getEfficiencyFactor ( ) const

noexceptinherited

Retrieves the efficiency factor of the antenna.

Returns

The efficiency factor of the antenna.

Definition at line 73 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()

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

overridevirtualnoexcept

Computes the gain of the parabolic 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 121 of file antenna_factory.cpp.

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

References PI.

getName()

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

noexceptinherited

Retrieves the name of the antenna.

Returns

The name of the antenna.

Definition at line 80 of file antenna_factory.h.

{ return _name; }

Referenced by antenna::to_json(), radar::to_json(), and radar::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 89 of file antenna_factory.h.

{ return 0; }

operator=() [1/2]

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

delete

operator=() [2/2]

Parabolic & antenna::Parabolic::operator= ( Parabolic &&  )

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

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

References LOG.

---

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