astro::rise_set::Result Struct Reference

The result of a rise/transit/set calculation for one date. More...

#include <rise_set.hpp>

Public Attributes
std::optional< double >	rise_jde_tt
std::optional< double >	set_jde_tt
std::optional< double >	transit_jde_tt
Polar	polar

Detailed Description

The result of a rise/transit/set calculation for one date.

Note

All instants are JDE, on the TT scale, like every other moment produced by this library. Use julian_day::jde_to_ut1 to read them as civil (UT1) datetimes.

transit_jde_tt is nullopt only for window-based queries (calculate_day) on dates where the body does not transit inside the window — a regular occurrence for the Moon, whose transits are ~24.84 h apart. Transit-centered queries always produce a transit.

polar is DAY/NIGHT only when neither rise nor set exists in the queried window; on transition days one of the two events can exist alone, in which case it stays NONE.

Member Data Documentation

polar

Polar astro::rise_set::Result::polar

rise_jde_tt

std::optional<double> astro::rise_set::Result::rise_jde_tt

set_jde_tt

std::optional<double> astro::rise_set::Result::set_jde_tt

transit_jde_tt

std::optional<double> astro::rise_set::Result::transit_jde_tt

---

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

• rise_set.hpp