parameters.h File Reference

Defines the Parameters struct and provides methods for managing simulation parameters. More...

#include <chrono>
#include <optional>
#include <string>
#include "config.h"
#include "logging.h"

Include dependency graph for parameters.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	params::Parameters
	Struct to hold simulation parameters. More...

Namespaces
namespace	params

Enumerations
enum class	params::CoordinateFrame { params::ENU , params::UTM , params::ECEF }
	Defines the coordinate systems supported for scenario definition. More...

Functions
RealType	params::c () noexcept
	Get the speed of light.
RealType	params::boltzmannK () noexcept
	Get the Boltzmann constant.
RealType	params::startTime () noexcept
	Get the start time for the simulation.
RealType	params::endTime () noexcept
	Get the end time for the simulation.
RealType	params::simSamplingRate () noexcept
	Get the simulation sampling rate.
RealType	params::rate () noexcept
	Get the rendering sample rate.
unsigned	params::randomSeed () noexcept
	Get the random seed.
unsigned	params::adcBits () noexcept
	Get the ADC quantization bits.
unsigned	params::renderFilterLength () noexcept
	Get the render filter length.
unsigned	params::renderThreads () noexcept
	Get the number of worker threads.
unsigned	params::oversampleRatio () noexcept
	Get the oversampling ratio.
void	params::setC (RealType cValue) noexcept
	Set the speed of light.
void	params::setTime (const RealType startTime, const RealType endTime) noexcept
	Set the start and end times for the simulation.
void	params::setSimSamplingRate (const RealType rate) noexcept
	Set the simulation sampling rate.
void	params::setRate (RealType rateValue)
	Set the rendering sample rate.
void	params::setRandomSeed (const unsigned seed) noexcept
	Set the random seed.
void	params::setAdcBits (const unsigned bits) noexcept
	Set the ADC quantization bits.
void	params::setOversampleRatio (unsigned ratio)
	Set the oversampling ratio.
void	params::setOrigin (const double lat, const double lon, const double alt) noexcept
	Set the geodetic origin for the KML generator.
double	params::originLatitude () noexcept
double	params::originLongitude () noexcept
double	params::originAltitude () noexcept
std::expected< void, std::string >	params::setThreads (const unsigned threads) noexcept
	Set the number of worker threads.
void	params::setCoordinateSystem (const CoordinateFrame frame, const int zone, const bool north) noexcept
	Set the coordinate system for the scenario.
CoordinateFrame	params::coordinateFrame () noexcept
int	params::utmZone () noexcept
bool	params::utmNorthHemisphere () noexcept

Variables
Parameters	params::params

Detailed Description

Defines the Parameters struct and provides methods for managing simulation parameters.

Definition in file parameters.h.