The World class manages the simulator environment. More...

#include "world.h"

Public Member Functions
	World ()=default

	~World () noexcept=default

	World (const World &)=delete

World &	operator= (const World &)=delete

	World (World &&)=delete

World &	operator= (World &&)=delete

void	add (std::unique_ptr< radar::Platform > plat) noexcept
	Adds a radar platform to the simulation world.

void	add (std::unique_ptr< radar::Transmitter > trans) noexcept
	Adds a radar transmitter to the simulation world.

void	add (std::unique_ptr< radar::Receiver > recv) noexcept
	Adds a radar receiver to the simulation world.

void	add (std::unique_ptr< radar::Target > target) noexcept
	Adds a radar target to the simulation world.

void	add (std::unique_ptr< fers_signal::RadarSignal > waveform)
	Adds a radar signal (waveform) to the simulation world.

void	add (std::unique_ptr< antenna::Antenna > antenna)
	Adds an antenna to the simulation world.

void	add (std::unique_ptr< timing::PrototypeTiming > timing)
	Adds a timing source to the simulation world.

fers_signal::RadarSignal *	findWaveform (const std::string &name)
	Finds a radar signal by name.

antenna::Antenna *	findAntenna (const std::string &name)
	Finds an antenna by name.

timing::PrototypeTiming *	findTiming (const std::string &name)
	Finds a timing source by name.

const std::vector< std::unique_ptr< radar::Platform > > &	getPlatforms () const noexcept
	Retrieves the list of platforms.

const std::vector< std::unique_ptr< radar::Target > > &	getTargets () const noexcept
	Retrieves the list of radar targets.

const std::vector< std::unique_ptr< radar::Receiver > > &	getReceivers () const noexcept
	Retrieves the list of radar receivers.

const std::vector< std::unique_ptr< radar::Transmitter > > &	getTransmitters () const noexcept
	Retrieves the list of radar transmitters.

const std::unordered_map< std::string, std::unique_ptr< fers_signal::RadarSignal > > &	getWaveforms () const noexcept
	Retrieves the map of radar signals (waveforms).

const std::unordered_map< std::string, std::unique_ptr< antenna::Antenna > > &	getAntennas () const noexcept
	Retrieves the map of antennas.

const std::unordered_map< std::string, std::unique_ptr< timing::PrototypeTiming > > &	getTimings () const noexcept
	Retrieves the map of timing prototypes.

void	clear () noexcept
	Clears all objects and assets from the simulation world.

void	scheduleInitialEvents ()
	Populates the event queue with the initial events for the simulation.

std::string	dumpEventQueue () const
	Dumps the current state of the event queue to a string for debugging.

std::priority_queue< Event, std::vector< Event >, EventComparator > &	getEventQueue () noexcept
	Gets a mutable reference to the global event queue.

SimulationState &	getSimulationState () noexcept
	Gets a mutable reference to the global simulation state.

Detailed Description

The World class manages the simulator environment.

Definition at line 37 of file world.h.

Constructor & Destructor Documentation

◆ World() [1/3]

core::World::World ( )

default

◆ ~World()

core::World::~World ( )

defaultnoexcept

◆ World() [2/3]

core::World::World ( const World & )

delete

◆ World() [3/3]

core::World::World ( World && )

delete

Member Function Documentation

◆ add() [1/7]

void core::World::add ( std::unique_ptr< antenna::Antenna > antenna )

Adds an antenna to the simulation world.

Parameters

antenna A unique pointer to an Antenna object.

Exceptions

std::runtime_error if an antenna with the same name already exists.

Definition at line 52 of file world.cpp.

    {
        if (_antennas.contains(antenna->getName()))
        {
            throw std::runtime_error("An antenna with the name " + antenna->getName() + " already exists.");
        }
        _antennas[antenna->getName()] = std::move(antenna);
    }

◆ add() [2/7]

void core::World::add ( std::unique_ptr< fers_signal::RadarSignal > waveform )

Adds a radar signal (waveform) to the simulation world.

Parameters

waveform A unique pointer to a RadarSignal object.

Exceptions

std::runtime_error if a waveform with the same name already exists.

Definition at line 43 of file world.cpp.

    {
        if (_waveforms.contains(waveform->getName()))
        {
            throw std::runtime_error("A waveform with the name " + waveform->getName() + " already exists.");
        }
        _waveforms[waveform->getName()] = std::move(waveform);
    }

◆ add() [3/7]

void core::World::add ( std::unique_ptr< radar::Platform > plat )

noexcept

Adds a radar platform to the simulation world.

Parameters

plat	A unique pointer to a Platform object.

Definition at line 35 of file world.cpp.

35{ _platforms.push_back(std::move(plat)); }

Referenced by serial::json_to_world().

Here is the caller graph for this function:

◆ add() [4/7]

void core::World::add ( std::unique_ptr< radar::Receiver > recv )

noexcept

Adds a radar receiver to the simulation world.

Parameters

recv	A unique pointer to a Receiver object.

Definition at line 39 of file world.cpp.

39{ _receivers.push_back(std::move(recv)); }

◆ add() [5/7]

void core::World::add ( std::unique_ptr< radar::Target > target )

noexcept

Adds a radar target to the simulation world.

Parameters

target A unique pointer to a Target object.

Definition at line 41 of file world.cpp.

41{ _targets.push_back(std::move(target)); }

◆ add() [6/7]

void core::World::add ( std::unique_ptr< radar::Transmitter > trans )

noexcept

Adds a radar transmitter to the simulation world.

Parameters

trans A unique pointer to a Transmitter object.

Definition at line 37 of file world.cpp.

37{ _transmitters.push_back(std::move(trans)); }

◆ add() [7/7]

void core::World::add ( std::unique_ptr< timing::PrototypeTiming > timing )

Adds a timing source to the simulation world.

Parameters

timing A unique pointer to a PrototypeTiming object.

Exceptions

std::runtime_error if a timing source with the same name already exists.

Definition at line 61 of file world.cpp.

    {
        if (_timings.contains(timing->getName()))
        {
            throw std::runtime_error("A timing source with the name " + timing->getName() + " already exists.");
        }
        _timings[timing->getName()] = std::move(timing);
    }

◆ clear()

void core::World::clear ( )

noexcept

Clears all objects and assets from the simulation world.

Definition at line 85 of file world.cpp.

    {
        _platforms.clear();
        _transmitters.clear();
        _receivers.clear();
        _targets.clear();
        _waveforms.clear();
        _antennas.clear();
        _timings.clear();
        _event_queue = {};
        _simulation_state = {};
    }

Referenced by serial::json_to_world(), serial::parseSimulation(), and serial::parseSimulationFromString().

Here is the caller graph for this function:

◆ dumpEventQueue()

std::string core::World::dumpEventQueue ( ) const

Dumps the current state of the event queue to a string for debugging.

Returns: A formatted string representing the contents of the event queue.

Definition at line 180 of file world.cpp.

    {
        if (_event_queue.empty())
        {
            return "Event Queue is empty.\n";
        }
 
        std::stringstream ss;
        ss << std::fixed << std::setprecision(6);
 
        const std::string separator = "--------------------------------------------------------------------";
        const std::string title = "| Event Queue Contents (" + std::to_string(_event_queue.size()) + " events)";
 
        ss << separator << "\n"
           << std::left << std::setw(separator.length() - 1) << title << "|\n"
           << separator << "\n"
           << "| " << std::left << std::setw(12) << "Timestamp" << " | " << std::setw(21) << "Event Type" << " | "
           << std::setw(25) << "Source Object" << " |\n"
           << separator << "\n";
 
        auto queue_copy = _event_queue;
 
        while (!queue_copy.empty())
        {
            const auto [timestamp, event_type, source_object] = queue_copy.top();
            queue_copy.pop();
 
            ss << "| " << std::right << std::setw(12) << timestamp << " | " << std::left << std::setw(21)
               << toString(event_type) << " | " << std::left << std::setw(25) << source_object->getName() << " |\n";
        }
        ss << separator << "\n";
 
        return ss.str();
    }

References core::toString().

Here is the call graph for this function:

◆ findAntenna()

Antenna * core::World::findAntenna ( const std::string & name )

Finds an antenna by name.

Parameters

name	The name of the antenna to find.

Returns: A pointer to the Antenna if found, or nullptr if not found.

Definition at line 75 of file world.cpp.

    {
        return _antennas.contains(name) ? _antennas[name].get() : nullptr;
    }

Referenced by serial::json_to_world().

Here is the caller graph for this function:

◆ findTiming()

PrototypeTiming * core::World::findTiming ( const std::string & name )

Finds a timing source by name.

Parameters

name	The name of the timing source to find.

Returns: A pointer to the PrototypeTiming if found, or nullptr if not found.

Definition at line 80 of file world.cpp.

    {
        return _timings.contains(name) ? _timings[name].get() : nullptr;
    }

Referenced by serial::json_to_world().

Here is the caller graph for this function:

◆ findWaveform()

RadarSignal * core::World::findWaveform ( const std::string & name )

Finds a radar signal by name.

Parameters

name	The name of the radar signal to find.

Returns: A pointer to the RadarSignal if found, or nullptr if not found.

Definition at line 70 of file world.cpp.

    {
        return _waveforms.contains(name) ? _waveforms[name].get() : nullptr;
    }

Referenced by serial::json_to_world().

Here is the caller graph for this function:

◆ getAntennas()

const std::unordered_map< std::string, std::unique_ptr< antenna::Antenna > > & core::World::getAntennas ( ) const

noexcept

Retrieves the map of antennas.

Returns: A const reference to the map of antenna names to Antenna objects.

Definition at line 183 of file world.h.

        {
            return _antennas;
        }

Referenced by serial::world_to_json(), and serial::world_to_xml_string().

Here is the caller graph for this function:

◆ getEventQueue()

std::priority_queue< Event, std::vector< Event >, EventComparator > & core::World::getEventQueue ( )

noexcept

Gets a mutable reference to the global event queue.

Returns: A reference to the priority queue of events.

Definition at line 219 of file world.h.

        {
            return _event_queue;
        }

Referenced by core::runEventDrivenSim().

Here is the caller graph for this function:

◆ getPlatforms()

const std::vector< std::unique_ptr< radar::Platform > > & core::World::getPlatforms ( ) const

noexcept

Retrieves the list of platforms.

Returns: A const reference to a vector of unique pointers to Platform objects.

Definition at line 133 of file world.h.

        {
            return _platforms;
        }

Referenced by serial::world_to_json(), and serial::world_to_xml_string().

Here is the caller graph for this function:

◆ getReceivers()

const std::vector< std::unique_ptr< radar::Receiver > > & core::World::getReceivers ( ) const

noexcept

Retrieves the list of radar receivers.

Returns: A const reference to a vector of unique pointers to Receiver objects.

Definition at line 153 of file world.h.

        {
            return _receivers;
        }

Referenced by simulation::calculatePreviewLinks(), serial::KmlGenerator::generateKml(), serial::json_to_world(), core::runEventDrivenSim(), and serial::world_to_json().

Here is the caller graph for this function:

◆ getSimulationState()

SimulationState & core::World::getSimulationState ( )

noexcept

Gets a mutable reference to the global simulation state.

Returns: A reference to the SimulationState object.

Definition at line 228 of file world.h.

228{ return _simulation_state; }

Referenced by core::runEventDrivenSim().

Here is the caller graph for this function:

◆ getTargets()

const std::vector< std::unique_ptr< radar::Target > > & core::World::getTargets ( ) const

noexcept

Retrieves the list of radar targets.

Returns: A const reference to a vector of unique pointers to Target objects.

Definition at line 143 of file world.h.

        {
            return _targets;
        }

Referenced by simulation::calculatePreviewLinks(), serial::KmlGenerator::generateKml(), serial::json_to_world(), core::runEventDrivenSim(), and serial::world_to_json().

Here is the caller graph for this function:

◆ getTimings()

const std::unordered_map< std::string, std::unique_ptr< timing::PrototypeTiming > > & core::World::getTimings ( ) const

noexcept

Retrieves the map of timing prototypes.

Returns: A const reference to the map of timing names to PrototypeTiming objects.

Definition at line 193 of file world.h.

        {
            return _timings;
        }

Referenced by serial::world_to_json(), and serial::world_to_xml_string().

Here is the caller graph for this function:

◆ getTransmitters()

const std::vector< std::unique_ptr< radar::Transmitter > > & core::World::getTransmitters ( ) const

noexcept

Retrieves the list of radar transmitters.

Returns: A const reference to a vector of unique pointers to Transmitter objects.

Definition at line 163 of file world.h.

        {
            return _transmitters;
        }

Referenced by simulation::calculatePreviewLinks(), serial::KmlGenerator::generateKml(), and serial::world_to_json().

Here is the caller graph for this function:

◆ getWaveforms()

const std::unordered_map< std::string, std::unique_ptr< fers_signal::RadarSignal > > & core::World::getWaveforms ( ) const

noexcept

Retrieves the map of radar signals (waveforms).

Returns: A const reference to the map of signal names to RadarSignal objects.

Definition at line 173 of file world.h.

        {
            return _waveforms;
        }

Referenced by serial::world_to_json(), and serial::world_to_xml_string().

Here is the caller graph for this function:

◆ operator=() [1/2]

World & core::World::operator= ( const World & )

delete

◆ operator=() [2/2]

World & core::World::operator= ( World && )

delete

◆ scheduleInitialEvents()

void core::World::scheduleInitialEvents ( )

Populates the event queue with the initial events for the simulation.

This method should be called after all simulation objects have been parsed and added to the world.

Definition at line 98 of file world.cpp.

    {
        const RealType sim_start = params::startTime();
        const RealType sim_end = params::endTime();
 
        for (const auto& transmitter : _transmitters)
        {
            if (transmitter->getMode() == radar::OperationMode::PULSED_MODE)
            {
                // Find the first valid pulse time starting from the simulation start time.
                if (auto start_time = transmitter->getNextPulseTime(sim_start); start_time)
                {
                    if (*start_time <= sim_end)
                    {
                        _event_queue.push({*start_time, EventType::TX_PULSED_START, transmitter.get()});
                    }
                }
            }
            else // CW_MODE
            {
                const auto& schedule = transmitter->getSchedule();
                if (schedule.empty())
                {
                    // Legacy behavior: Always on for simulation duration
                    _event_queue.push({sim_start, EventType::TX_CW_START, transmitter.get()});
                    _event_queue.push({sim_end, EventType::TX_CW_END, transmitter.get()});
                }
                else
                {
                    for (const auto& period : schedule)
                    {
                        // Clip periods to simulation bounds
                        const RealType start = std::max(sim_start, period.start);
                        const RealType end = std::min(sim_end, period.end);
 
                        if (start < end)
                        {
                            _event_queue.push({start, EventType::TX_CW_START, transmitter.get()});
                            _event_queue.push({end, EventType::TX_CW_END, transmitter.get()});
                        }
                    }
                }
            }
        }
 
        for (const auto& receiver : _receivers)
        {
            if (receiver->getMode() == radar::OperationMode::PULSED_MODE)
            {
                // Schedule the first receive window checking against schedule
                const RealType nominal_start = receiver->getWindowStart(0);
                if (auto start = receiver->getNextWindowTime(nominal_start); start && *start < params::endTime())
                {
                    _event_queue.push({*start, EventType::RX_PULSED_WINDOW_START, receiver.get()});
                }
            }
            else // CW_MODE
            {
                const auto& schedule = receiver->getSchedule();
                if (schedule.empty())
                {
                    // Legacy behavior: Always on for simulation duration
                    _event_queue.push({params::startTime(), EventType::RX_CW_START, receiver.get()});
                    _event_queue.push({params::endTime(), EventType::RX_CW_END, receiver.get()});
                }
                else
                {
                    for (const auto& period : schedule)
                    {
                        const RealType start = std::max(params::startTime(), period.start);
                        const RealType end = std::min(params::endTime(), period.end);
                        if (start < end)
                        {
                            _event_queue.push({start, EventType::RX_CW_START, receiver.get()});
                            _event_queue.push({end, EventType::RX_CW_END, receiver.get()});
                        }
                    }
                }
            }
        }
    }

References params::endTime(), radar::PULSED_MODE, core::RX_CW_END, core::RX_CW_START, core::RX_PULSED_WINDOW_START, params::startTime(), core::TX_CW_END, core::TX_CW_START, and core::TX_PULSED_START.

Referenced by serial::json_to_world().

Here is the call graph for this function:

Here is the caller graph for this function:

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

packages/libfers/src/core/world.h
packages/libfers/src/core/world.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ World() [1/3]

◆ ~World()

◆ World() [2/3]

◆ World() [3/3]

Member Function Documentation

◆ add() [1/7]

◆ add() [2/7]

◆ add() [3/7]

◆ add() [4/7]

◆ add() [5/7]

◆ add() [6/7]

◆ add() [7/7]

◆ clear()

◆ dumpEventQueue()

◆ findAntenna()

◆ findTiming()

◆ findWaveform()

◆ getAntennas()

◆ getEventQueue()

◆ getPlatforms()

◆ getReceivers()

◆ getSimulationState()

◆ getTargets()

◆ getTimings()

◆ getTransmitters()

◆ getWaveforms()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ scheduleInitialEvents()