Represents a radar transmitter system. More...

#include "transmitter.h"

Inheritance diagram for radar::Transmitter:

Collaboration diagram for radar::Transmitter:

Public Member Functions
	Transmitter (Platform *platform, std::string name, const OperationMode mode) noexcept
	Constructor for the Transmitter class.

	~Transmitter () override=default

	Transmitter (const Transmitter &)=delete

Transmitter &	operator= (const Transmitter &)=delete

	Transmitter (Transmitter &&)=delete

Transmitter &	operator= (Transmitter &&)=delete

RealType	getPrf () const noexcept
	Retrieves the pulse repetition frequency (PRF).

fers_signal::RadarSignal *	getSignal () const noexcept
	Retrieves the radar signal currently being transmitted.

OperationMode	getMode () const noexcept
	Gets the operational mode of the transmitter.

void	setWave (fers_signal::RadarSignal *pulse) noexcept
	Sets the radar signal wave to be transmitted.

void	setSignal (fers_signal::RadarSignal *signal) noexcept
	Sets the radar signal wave to be transmitted.

void	setPrf (RealType mprf) noexcept
	Sets the pulse repetition frequency (PRF) of the transmitter.

void	setSchedule (std::vector< SchedulePeriod > schedule)
	Sets the active schedule for the transmitter.

const std::vector< SchedulePeriod > &	getSchedule () const noexcept
	Retrieves the list of active transmission periods.

std::optional< RealType >	getNextPulseTime (RealType time) const
	Determines the valid simulation time for a pulse at or after the given time.

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 transmitter system.

Definition at line 31 of file transmitter.h.

Constructor & Destructor Documentation

◆ Transmitter() [1/3]

radar::Transmitter::Transmitter	(	Platform *	platform,
		std::string	name,
		const OperationMode	mode
	)

noexcept

Constructor for the Transmitter class.

Parameters

platform	Pointer to the platform object.
name	Name of the transmitter.
mode	The operational mode (PULSED_MODE or CW_MODE).

Definition at line 41 of file transmitter.h.

                                                                                           :
            Radar(platform, std::move(name)), _mode(mode)
        {
        }

◆ ~Transmitter()

radar::Transmitter::~Transmitter ( )

overridedefault

◆ Transmitter() [2/3]

radar::Transmitter::Transmitter ( const Transmitter & )

delete

◆ Transmitter() [3/3]

radar::Transmitter::Transmitter ( Transmitter && )

delete

Member Function Documentation

◆ getAntenna()

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

noexceptinherited

Gets the antenna associated with this radar.

Returns: Pointer to the associated antenna.

Definition at line 78 of file radar_obj.h.

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

noexceptinherited

Retrieves the attached radar object.

Returns: Pointer to the attached radar object.

Definition at line 71 of file radar_obj.h.

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

inherited

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:

◆ getMode()

OperationMode radar::Transmitter::getMode ( ) const

noexcept

Gets the operational mode of the transmitter.

Returns: The operational mode (PULSED_MODE or CW_MODE).

Definition at line 75 of file transmitter.h.

75{ return _mode; }

Referenced by radar::to_json().

Here is the caller 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.

68{ 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:

◆ getNextPulseTime()

std::optional< RealType > radar::Transmitter::getNextPulseTime ( RealType time ) const

Determines the valid simulation time for a pulse at or after the given time.

If the requested time falls within an active period, it is returned. If it falls in a gap between periods, the start of the next period is returned. If it falls after all periods, std::nullopt is returned. If no schedule is defined, the transmitter is considered "always on".

Parameters

time	The proposed pulse time.

Returns: The actual pulse time, or nullopt if no valid time exists.

Definition at line 31 of file transmitter.cpp.

    {
        // If no schedule is defined, assume always on.
        if (_schedule.empty())
        {
            return time;
        }
 
        for (const auto& period : _schedule)
        {
            // If time is within this period, it's valid.
            if (time >= period.start && time <= period.end)
            {
                return time;
            }
            // If time is before this period, skip to the start of this period.
            if (time < period.start)
            {
                return period.start;
            }
            // If time is after this period, continue to next period.
        }
 
        // Time is after the last scheduled period.
        return std::nullopt;
    }

◆ getNoiseTemperature()

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

virtualnoexceptinherited

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.

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

46{ return _platform->getPosition(time); }

radar::Platform::getPosition

math::Vec3 getPosition(const RealType time) const

Gets the position of the platform at a specific time.

Definition platform.h:74

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:

◆ getPrf()

RealType radar::Transmitter::getPrf ( ) const

noexcept

Retrieves the pulse repetition frequency (PRF).

Returns: The current PRF of the transmitter.

Definition at line 61 of file transmitter.h.

61{ return _prf; }

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

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.

54{ return _platform->getRotation(time); }

radar::Platform::getRotation

math::SVec3 getRotation(const RealType time) const

Gets the rotation of the platform at a specific time.

Definition platform.h:82

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:

◆ getSchedule()

const std::vector< SchedulePeriod > & radar::Transmitter::getSchedule ( ) const

noexcept

Retrieves the list of active transmission periods.

Returns: A const reference to the schedule vector.

Definition at line 110 of file transmitter.h.

110{ return _schedule; }

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

Here is the caller graph for this function:

◆ getSignal()

fers_signal::RadarSignal * radar::Transmitter::getSignal ( ) const

noexcept

Retrieves the radar signal currently being transmitted.

Returns: Pointer to the RadarSignal object being transmitted.

Definition at line 68 of file transmitter.h.

68{ return _signal; }

Referenced by simulation::calculateDirectPathContribution(), simulation::calculatePreviewLinks(), simulation::calculateReflectedPathContribution(), and radar::to_json().

Here is the caller graph for this function:

◆ getTiming()

std::shared_ptr< timing::Timing > radar::Radar::getTiming ( ) const

inherited

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 radar::Radar::_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]

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

delete

◆ operator=() [2/2]

Transmitter & radar::Transmitter::operator= ( Transmitter && )

delete

◆ setAntenna()

void radar::Radar::setAntenna ( const antenna::Antenna * ant )

inherited

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 )

inherited

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.

◆ setPrf()

void radar::Transmitter::setPrf ( RealType mprf )

noexcept

Sets the pulse repetition frequency (PRF) of the transmitter.

Parameters

mprf	Desired PRF to be set.

Definition at line 19 of file transmitter.cpp.

    {
        const RealType rate = params::rate() * params::oversampleRatio();
        _prf = 1 / (std::floor(rate / mprf) / rate);
    }

References params::oversampleRatio(), and params::rate().

Here is the call graph for this function:

◆ setSchedule()

void radar::Transmitter::setSchedule ( std::vector< SchedulePeriod > schedule )

Sets the active schedule for the transmitter.

The provided schedule should be pre-validated and sorted.

Parameters

schedule A vector of active periods.

Definition at line 25 of file transmitter.cpp.

    {
        // The schedule is assumed to be sorted and merged by the parser.
        _schedule = std::move(schedule);
    }

◆ setSignal()

void radar::Transmitter::setSignal ( fers_signal::RadarSignal * signal )

noexcept

Sets the radar signal wave to be transmitted.

Parameters

signal Pointer to the RadarSignal object to be transmitted.

Definition at line 89 of file transmitter.h.

89{ _signal = signal; }

◆ setTiming()

void radar::Radar::setTiming ( const std::shared_ptr< timing::Timing > & tim )

inherited

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 radar::Radar::_timing, and LOG.

◆ setWave()

void radar::Transmitter::setWave ( fers_signal::RadarSignal * pulse )

noexcept

Sets the radar signal wave to be transmitted.

Parameters

pulse Pointer to the RadarSignal object representing the wave.

Definition at line 82 of file transmitter.h.

82{ _signal = pulse; }

Member Data Documentation

◆ _timing

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

protectedinherited

Timing source for the radar.

Definition at line 129 of file radar_obj.h.

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

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

packages/libfers/src/radar/transmitter.h
packages/libfers/src/radar/transmitter.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Transmitter() [1/3]

◆ ~Transmitter()

◆ Transmitter() [2/3]

◆ Transmitter() [3/3]

Member Function Documentation

◆ getAntenna()

◆ getAttached()

◆ getGain()

◆ getMode()

◆ getName()

◆ getNextPulseTime()

◆ getNoiseTemperature()

◆ getPlatform()

◆ getPosition()

◆ getPrf()

◆ getRotation()

◆ getSchedule()

◆ getSignal()

◆ getTiming()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setAntenna()

◆ setAttached()

◆ setPrf()

◆ setSchedule()

◆ setSignal()

◆ setTiming()

◆ setWave()

Member Data Documentation

◆ _timing