timeUtils.h

Go to the documentation of this file.

 
#pragma once
 
#include <string>
#include <ctime>
 
namespace dpyTime {
 
std::string getLocalTimeStamp();
 
struct tm getLocalTime();
 
class SunTimes
{
public:
    enum class ZenithPreset {
        Official,      // 90°50' = 90.833°
        Civil,         // 96°
        Nautical,      // 102°
        Astronomical   // 108°
    };
 
    static double zenithDeg(ZenithPreset preset);
 
    SunTimes(double latitudeDeg,
             double longitudeDeg,
             ZenithPreset preset = ZenithPreset::Official);
 
    SunTimes(double latitudeDeg,
             double longitudeDeg,
             double zenithDeg);
 
    bool compute(const std::tm& localDate,
                 std::time_t& sunriseLocal,
                 std::time_t& sunsetLocal) const;
 
    bool compute(std::time_t currentLocal,
                 std::time_t& sunriseLocal,
                 std::time_t& sunsetLocal) const;
 
    bool isDay(std::time_t nowLocal) const;
 
private:
    double lat_;
    double lon_;
    double zenith_;
 
    enum class EventKind {
        Ok,
        PolarNight,
        PolarDay,
        Error
    };
 
    struct EventUtcHoursResult
    {
        EventKind status = EventKind::Error;
        double utcHours = 0.0;
    };
 
    static EventUtcHoursResult sunEventUtcHours(const std::tm& localDate,
                                                double latitudeDeg, double longitudeDeg,
                                                double zenithDeg, bool rising);
 
    static std::time_t buildUtcTime(const std::tm& baseDate, double utcHours);
    static std::tm shiftLocalDate(const std::tm& baseDate, int dayOffset);
    bool findNearestEvent(const std::tm& baseDate,
                          bool rising,
                          int firstDayOffset,
                          int dayStep,
                          std::time_t& eventLocal) const;
};
 
bool getSunriseSunsetLocal(const std::tm& localDate,
                           double latitudeDeg, double longitudeDeg,
                           SunTimes::ZenithPreset preset,
                           std::time_t& sunriseLocal,
                           std::time_t& sunsetLocal);
 
bool getSunriseSunsetLocal(std::time_t nowLocal,
                           double latitudeDeg, double longitudeDeg,
                           SunTimes::ZenithPreset preset,
                           std::time_t& sunriseLocal,
                           std::time_t& sunsetLocal);
 
bool isDayLocal(std::time_t nowLocal,
                double latitudeDeg, double longitudeDeg,
                SunTimes::ZenithPreset preset);
 
} /* namespace dpyTime */