siderust::SearchOptions Struct Reference

Options for altitude search algorithms. More...

#include <siderust/altitude.hpp>

Public Member Functions
	SearchOptions ()=default
SearchOptions &	with_scan_step (double step)
	Set a custom scan step.
SearchOptions &	with_tolerance (double tol)
	Set time tolerance.
siderust_search_opts_t	to_c () const

Public Attributes
double	time_tolerance_days = 1e-9
double	scan_step_days = 0.0
bool	has_scan_step = false

Detailed Description

Options for altitude search algorithms.

Examples

altitude_events_example.cpp.

Definition at line 55 of file altitude.hpp.

Constructor & Destructor Documentation

SearchOptions()

siderust::SearchOptions::SearchOptions ( )

default

Member Function Documentation

to_c()

siderust_search_opts_t siderust::SearchOptions::to_c ( ) const

inline

Definition at line 75 of file altitude.hpp.

References has_scan_step, scan_step_days, and time_tolerance_days.

with_scan_step()

SearchOptions & siderust::SearchOptions::with_scan_step ( double  step )

inline

Set a custom scan step.

Examples

altitude_events_example.cpp.

Definition at line 63 of file altitude.hpp.

References has_scan_step, and scan_step_days.

Referenced by main().

with_tolerance()

SearchOptions & siderust::SearchOptions::with_tolerance ( double  tol )

inline

Set time tolerance.

Examples

altitude_events_example.cpp.

Definition at line 70 of file altitude.hpp.

References time_tolerance_days.

Referenced by main().

Member Data Documentation

has_scan_step

bool siderust::SearchOptions::has_scan_step = false

Definition at line 58 of file altitude.hpp.

Referenced by to_c(), and with_scan_step().

scan_step_days

double siderust::SearchOptions::scan_step_days = 0.0

Definition at line 57 of file altitude.hpp.

Referenced by to_c(), and with_scan_step().

time_tolerance_days

double siderust::SearchOptions::time_tolerance_days = 1e-9

Definition at line 56 of file altitude.hpp.

Referenced by to_c(), and with_tolerance().

---

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

• altitude.hpp