Struct to hold simulation parameters. More...

#include "parameters.h"

Public Member Functions
void	reset () noexcept
	Resets the parameters to their default-constructed state.

Public Attributes
RealType	c = DEFAULT_C
	Speed of light (modifiable)

RealType	boltzmann_k = DEFAULT_BOLTZMANN_K
	Boltzmann constant.

RealType	start = 0
	Start time for the simulation.

RealType	end = 0
	End time for the simulation.

RealType	sim_sampling_rate = 1000
	Temporal sampling rate (Hz) that determines time-step resolution for radar pulse simulation.

double	origin_latitude = -33.957652
	Geodetic origin latitude.

double	origin_longitude = 18.4611991
	Geodetic origin longitude.

double	origin_altitude = 111.01
	Geodetic origin altitude (in meters)

CoordinateFrame	coordinate_frame = CoordinateFrame::ENU
	Scenario coordinate frame.

RotationAngleUnit	rotation_angle_unit = RotationAngleUnit::Degrees
	External rotation angle unit.

int	utm_zone = 0
	UTM zone (1-60), if applicable.

bool	utm_north_hemisphere = true
	UTM hemisphere, if applicable.

RealType	rate = 0
	Rendering sample rate.

std::optional< unsigned >	random_seed
	Random seed for simulation.

unsigned	adc_bits = 0
	ADC quantization bits.

unsigned	filter_length = 33
	Default render filter length.

unsigned	render_threads = 1
	Number of worker threads to use for parallel tasks.

std::string	simulation_name
	The name of the simulation, from the XML.

unsigned	oversample_ratio = 1
	Oversampling ratio.

Static Public Attributes
static constexpr RealType	DEFAULT_C = 299792458.0
	Speed of light (m/s)

static constexpr RealType	DEFAULT_BOLTZMANN_K = 1.3806503e-23
	Boltzmann constant.

Detailed Description

Struct to hold simulation parameters.

Definition at line 50 of file parameters.h.

Member Function Documentation

◆ reset()

void params::Parameters::reset ( )

noexcept

Resets the parameters to their default-constructed state.

This ensures all members are restored to the values specified by their default member initializers.

Definition at line 82 of file parameters.h.

82{ *this = Parameters{}; }

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

Here is the caller graph for this function:

Member Data Documentation

◆ adc_bits

unsigned params::Parameters::adc_bits = 0

ADC quantization bits.

Definition at line 71 of file parameters.h.

Referenced by serial::xml_parser_utils::parseParameters(), and serial::xml_serializer_utils::serializeParameters().

◆ boltzmann_k

RealType params::Parameters::boltzmann_k = DEFAULT_BOLTZMANN_K

Boltzmann constant.

Definition at line 55 of file parameters.h.

◆ c

RealType params::Parameters::c = DEFAULT_C

Speed of light (modifiable)

Definition at line 54 of file parameters.h.

Referenced by serial::kml_generator_utils::generateAntennaKml(), serial::xml_parser_utils::parseParameters(), and serial::xml_serializer_utils::serializeParameters().

◆ coordinate_frame

CoordinateFrame params::Parameters::coordinate_frame = CoordinateFrame::ENU

Scenario coordinate frame.

Definition at line 65 of file parameters.h.

Referenced by serial::KmlGenerator::generateKml(), serial::kml_generator_utils::generateKmlToStream(), serial::xml_parser_utils::parseParameters(), and serial::xml_serializer_utils::serializeParameters().

◆ DEFAULT_BOLTZMANN_K

constexpr RealType params::Parameters::DEFAULT_BOLTZMANN_K = 1.3806503e-23

staticconstexpr

Boltzmann constant.

Definition at line 53 of file parameters.h.

◆ DEFAULT_C

constexpr RealType params::Parameters::DEFAULT_C = 299792458.0

staticconstexpr

Speed of light (m/s)

Definition at line 52 of file parameters.h.

Referenced by serial::xml_parser_utils::parseParameters(), and serial::xml_serializer_utils::serializeParameters().

◆ end

RealType params::Parameters::end = 0

End time for the simulation.

Definition at line 57 of file parameters.h.

Referenced by serial::xml_parser_utils::parseParameters(), serial::xml_parser_utils::parseWaveform(), serial::xml_parser_utils::processParsedDocument(), and serial::xml_serializer_utils::serializeParameters().

◆ filter_length

unsigned params::Parameters::filter_length = 33

Default render filter length.

Definition at line 72 of file parameters.h.

◆ origin_altitude

double params::Parameters::origin_altitude = 111.01

Geodetic origin altitude (in meters)

Definition at line 64 of file parameters.h.

Referenced by serial::KmlGenerator::generateKml(), serial::kml_generator_utils::generateKmlToStream(), serial::xml_parser_utils::parseParameters(), and serial::xml_serializer_utils::serializeParameters().

◆ origin_latitude

double params::Parameters::origin_latitude = -33.957652

Geodetic origin latitude.

Definition at line 62 of file parameters.h.

Referenced by serial::KmlGenerator::generateKml(), serial::kml_generator_utils::generateKmlToStream(), serial::xml_parser_utils::parseParameters(), and serial::xml_serializer_utils::serializeParameters().

◆ origin_longitude

double params::Parameters::origin_longitude = 18.4611991

Geodetic origin longitude.

Definition at line 63 of file parameters.h.

Referenced by serial::KmlGenerator::generateKml(), serial::kml_generator_utils::generateKmlToStream(), serial::xml_parser_utils::parseParameters(), and serial::xml_serializer_utils::serializeParameters().

◆ oversample_ratio

unsigned params::Parameters::oversample_ratio = 1

Oversampling ratio.

Definition at line 75 of file parameters.h.

Referenced by serial::xml_parser_utils::parseParameters(), serial::xml_parser_utils::processParsedDocument(), and serial::xml_serializer_utils::serializeParameters().

◆ random_seed

std::optional<unsigned> params::Parameters::random_seed

Random seed for simulation.

Definition at line 70 of file parameters.h.

Referenced by fers_load_scenario_from_xml_file(), fers_load_scenario_from_xml_string(), serial::xml_parser_utils::parseParameters(), and serial::xml_serializer_utils::serializeParameters().

◆ rate

RealType params::Parameters::rate = 0

Rendering sample rate.

Definition at line 69 of file parameters.h.

Referenced by serial::xml_parser_utils::parseParameters(), serial::xml_parser_utils::processParsedDocument(), and serial::xml_serializer_utils::serializeParameters().

◆ render_threads

unsigned params::Parameters::render_threads = 1

Number of worker threads to use for parallel tasks.

Definition at line 73 of file parameters.h.

◆ rotation_angle_unit

RotationAngleUnit params::Parameters::rotation_angle_unit = RotationAngleUnit::Degrees

External rotation angle unit.

Definition at line 66 of file parameters.h.

Referenced by serial::kml_generator_utils::generateDirectionalAntennaKml(), serial::xml_parser_utils::parseParameters(), serial::xml_parser_utils::parsePlatform(), and serial::xml_serializer_utils::serializeParameters().

◆ sim_sampling_rate

RealType params::Parameters::sim_sampling_rate = 1000

Temporal sampling rate (Hz) that determines time-step resolution for radar pulse simulation.

Definition at line 58 of file parameters.h.

Referenced by serial::xml_parser_utils::parseParameters(), and serial::xml_serializer_utils::serializeParameters().

◆ simulation_name

std::string params::Parameters::simulation_name

The name of the simulation, from the XML.

Definition at line 74 of file parameters.h.

Referenced by core::OutputMetadataCollector::OutputMetadataCollector(), serial::xml_parser_utils::processParsedDocument(), serial::world_to_json(), and serial::kml_generator_utils::writeKmlHeaderAndStyles().

◆ start

RealType params::Parameters::start = 0

Start time for the simulation.

Definition at line 56 of file parameters.h.

Referenced by serial::kml_generator_utils::generateDirectionalAntennaKml(), serial::xml_parser_utils::parseParameters(), serial::xml_parser_utils::parseWaveform(), serial::xml_parser_utils::processParsedDocument(), and serial::xml_serializer_utils::serializeParameters().

◆ utm_north_hemisphere

bool params::Parameters::utm_north_hemisphere = true

UTM hemisphere, if applicable.

Definition at line 68 of file parameters.h.

Referenced by serial::KmlGenerator::generateKml(), serial::xml_parser_utils::parseParameters(), and serial::xml_serializer_utils::serializeParameters().

◆ utm_zone

int params::Parameters::utm_zone = 0

UTM zone (1-60), if applicable.

Definition at line 67 of file parameters.h.

Referenced by serial::KmlGenerator::generateKml(), serial::xml_parser_utils::parseParameters(), and serial::xml_serializer_utils::serializeParameters().

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

packages/libfers/src/core/parameters.h

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ reset()

Member Data Documentation

◆ adc_bits

◆ boltzmann_k

◆ c

◆ coordinate_frame

◆ DEFAULT_BOLTZMANN_K

◆ DEFAULT_C

◆ end

◆ filter_length

◆ origin_altitude

◆ origin_latitude

◆ origin_longitude

◆ oversample_ratio

◆ random_seed

◆ rate

◆ render_threads

◆ rotation_angle_unit

◆ sim_sampling_rate

◆ simulation_name

◆ start

◆ utm_north_hemisphere

◆ utm_zone