radar::Radar Class Reference

Represents a radar system on a platform. More...

#include "radar_obj.h"

Inheritance diagram for radar::Radar:

Collaboration diagram for radar::Radar:

Public Member Functions
	Radar (Platform *platform, std::string name) noexcept
	Constructs a Radar object.
	~Radar () override=default
	Radar (const Radar &)=delete
Radar &	operator= (const Radar &)=delete
	Radar (Radar &&)=delete
Radar &	operator= (Radar &&)=delete
const Radar *	getAttached () const noexcept
	Retrieves the attached radar object.
const antenna::Antenna *	getAntenna () const noexcept
	Gets the antenna associated with this radar.
RealType	getGain (const math::SVec3 &angle, const math::SVec3 &refangle, RealType wavelength) const
	Calculates the radar gain based on input angles and wavelength.
virtual RealType	getNoiseTemperature (const math::SVec3 &angle) const noexcept
	Gets the noise temperature of the radar.
std::shared_ptr< timing::Timing >	getTiming () const
	Retrieves the timing source for the radar.
void	setTiming (const std::shared_ptr< timing::Timing > &tim)
	Sets the timing source for the radar.
void	setAntenna (const antenna::Antenna *ant)
	Sets the antenna for the radar.
void	setAttached (const Radar *obj)
	Attaches another radar object to this radar.
math::Vec3	getPosition (const RealType time) const
	Retrieves the position of the object.
math::SVec3	getRotation (const RealType time) const
	Retrieves the rotation of the object.
Platform *	getPlatform () const noexcept
	Retrieves the associated platform of the object.
const std::string &	getName () const noexcept
	Retrieves the name of the object.

Protected Attributes
std::shared_ptr< timing::Timing >	_timing
	Timing source for the radar.

Detailed Description

Represents a radar system on a platform.

Definition at line 45 of file radar_obj.h.

Constructor & Destructor Documentation

Radar() [1/3]

radar::Radar::Radar ( Platform *  platform, std::string  name  )

noexcept

Constructs a Radar object.

Parameters

platform	Pointer to the platform on which the radar is mounted.
name	Name of the radar object.

Definition at line 54 of file radar_obj.h.

: Object(platform, std::move(name)) {}

~Radar()

radar::Radar::~Radar ( )

overridedefault

Radar() [2/3]

radar::Radar::Radar ( const Radar &  )

delete

Radar() [3/3]

radar::Radar::Radar ( Radar &&  )

delete

Member Function Documentation

getAntenna()

const antenna::Antenna * radar::Radar::getAntenna ( ) const

noexcept

Gets the antenna associated with this radar.

Returns

Pointer to the associated antenna.

Definition at line 78 of file radar_obj.h.

{ return _antenna; }

Referenced by radar::to_json(), and radar::to_json().

Here is the caller graph for this function:

getAttached()

const Radar * radar::Radar::getAttached ( ) const

noexcept

Retrieves the attached radar object.

Returns

Pointer to the attached radar object.

Definition at line 71 of file radar_obj.h.

{ return _attached; }

Referenced by simulation::calculatePreviewLinks(), and simulation::calculateResponse().

Here is the caller graph for this function:

getGain()

RealType radar::Radar::getGain	(	const math::SVec3 &	angle,
		const math::SVec3 &	refangle,
		RealType	wavelength
	)		const

Calculates the radar gain based on input angles and wavelength.

Parameters

angle	The radar's pointing angle.
refangle	The reference angle for comparison.
wavelength	The wavelength of the radar signal.

Returns

The calculated radar gain.

Definition at line 26 of file radar_obj.cpp.

    {
        return _antenna->getGain(angle, refangle, wavelength);
    }

References antenna::Antenna::getGain().

Here is the call graph for this function:

getName()

const std::string & radar::Object::getName ( ) const

noexceptinherited

Retrieves the name of the object.

Returns

A const reference to the string representing the object's name.

Definition at line 68 of file object.h.

{ return _name; }

Referenced by simulation::calculatePreviewLinks(), simulation::calculateResponse(), processing::finalizeCwReceiver(), serial::Response::getTransmitterName(), processing::runPulsedFinalizer(), radar::Receiver::setNoiseTemperature(), radar::to_json(), radar::to_json(), and radar::to_json().

Here is the caller graph for this function:

getNoiseTemperature()

RealType radar::Radar::getNoiseTemperature ( const math::SVec3 &  angle ) const

virtualnoexcept

Gets the noise temperature of the radar.

Parameters

angle

The angle at which the noise temperature is calculated.

Returns

The calculated noise temperature.

Reimplemented in radar::Receiver.

Definition at line 31 of file radar_obj.cpp.

    {
        return _antenna->getNoiseTemperature(angle);
    }

Referenced by radar::Receiver::getNoiseTemperature().

Here is the caller graph for this function:

getPlatform()

Platform * radar::Object::getPlatform ( ) const

noexceptinherited

Retrieves the associated platform of the object.

Returns

A pointer to the Platform object associated with this object.

Definition at line 61 of file object.h.

{ return _platform; }

Referenced by simulation::calculateDirectPathContribution(), simulation::calculateReflectedPathContribution(), and simulation::calculateResponse().

Here is the caller graph for this function:

getPosition()

math::Vec3 radar::Object::getPosition ( const RealType  time ) const

inherited

Retrieves the position of the object.

Parameters

time	The time at which to get the position of the object.

Returns

A math::Vec3 representing the position of the object.

Definition at line 46 of file object.h.

{ return _platform->getPosition(time); }

References radar::Platform::getPosition().

Referenced by simulation::calculatePreviewLinks(), simulation::solveRe(), and simulation::solveReDirect().

Here is the call graph for this function:

Here is the caller graph for this function:

getRotation()

math::SVec3 radar::Object::getRotation ( const RealType  time ) const

inherited

Retrieves the rotation of the object.

Parameters

time	The time at which to get the rotation of the object.

Returns

A math::SVec3 representing the rotation of the object.

Definition at line 54 of file object.h.

{ return _platform->getRotation(time); }

References radar::Platform::getRotation().

Referenced by radar::FileTarget::getRcs(), and processing::runPulsedFinalizer().

Here is the call graph for this function:

Here is the caller graph for this function:

getTiming()

std::shared_ptr< timing::Timing > radar::Radar::getTiming

(

)

const

Retrieves the timing source for the radar.

Returns

Shared pointer to the timing source.

Definition at line 66 of file radar_obj.cpp.

    {
        if (!_timing)
        {
            LOG(Level::FATAL, "Radar::GetTiming called before timing set");
            throw std::runtime_error("Radar::GetTiming called before timing set");
        }
        return _timing;
    }

References _timing, and LOG.

Referenced by processing::finalizeCwReceiver(), processing::runPulsedFinalizer(), radar::to_json(), and radar::to_json().

Here is the caller graph for this function:

operator=() [1/2]

Radar & radar::Radar::operator= ( const Radar &  )

delete

operator=() [2/2]

Radar & radar::Radar::operator= ( Radar &&  )

delete

setAntenna()

void radar::Radar::setAntenna

(

const antenna::Antenna *

ant

)

Sets the antenna for the radar.

Parameters

ant	Pointer to the antenna to set.

Definition at line 46 of file radar_obj.cpp.

    {
        if (!ant)
        {
            LOG(Level::FATAL, "Transmitter's antenna set to null");
            throw std::logic_error("Transmitter's antenna set to null");
        }
        _antenna = ant;
    }

References LOG.

setAttached()

void radar::Radar::setAttached

(

const Radar *

obj

)

Attaches another radar object to this radar.

Parameters

obj	Pointer to the radar object to attach.

Exceptions

std::runtime_error

If another object is already attached.

Definition at line 56 of file radar_obj.cpp.

    {
        if (_attached)
        {
            LOG(Level::FATAL, "Attempted to attach second object to transmitter");
            throw std::runtime_error("Attempted to attach second object to transmitter");
        }
        _attached = obj;
    }

References LOG.

setTiming()

void radar::Radar::setTiming

(

const std::shared_ptr< timing::Timing > &

tim

)

Sets the timing source for the radar.

Parameters

tim	Shared pointer to the timing source to set.

Definition at line 36 of file radar_obj.cpp.

    {
        if (!tim)
        {
            LOG(Level::FATAL, "Radar timing source must not be null");
            throw std::runtime_error("Radar timing source must not be null");
        }
        _timing = tim;
    }

References _timing, and LOG.

Member Data Documentation

_timing

std::shared_ptr<timing::Timing> radar::Radar::_timing

protected

Timing source for the radar.

Definition at line 129 of file radar_obj.h.

Referenced by getTiming(), radar::Receiver::getWindowStart(), and setTiming().

---

The documentation for this class was generated from the following files:

• packages/libfers/src/radar/radar_obj.h
• packages/libfers/src/radar/radar_obj.cpp