sunset.h

Go to the documentation of this file.

/*
 * Provides the ability to calculate the local time for sunrise,
 * sunset, and moonrise at any point in time at any location in the world
 *
 * Original work used with permission maintaining license
 * Copyright (GPL) 2004 Mike Chirico mchirico@comcast.net
 * Modifications copyright
 * Copyright (GPL) 2015 Peter Buelow
 *
 * This file is part of the Sunset library
 *
 * Sunset is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * Sunset is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.    See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Foobar.    If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __SUNPOSITION_H__
#define __SUNPOSITION_H__
 
#include <cmath>
#include <ctime>
 
#ifndef M_PI
  #define M_PI 3.14159265358979323846264338327950288
#endif
 
class SunSet {
public:
    SunSet();
    SunSet(double, double, int);
    SunSet(double, double, double);
    ~SunSet();
 
    static constexpr double SUNSET_OFFICIAL = 90.833;       
    static constexpr double SUNSET_NAUTICAL = 102.0;        
    static constexpr double SUNSET_CIVIL = 96.0;            
    static constexpr double SUNSET_ASTONOMICAL = 108.0;     
    void setPosition(double, double, int);
    void setPosition(double, double, double);
    void setTZOffset(int);
    void setTZOffset(double);
    double setCurrentDate(int, int, int);
    double calcNauticalSunrise() const;
    double calcNauticalSunset() const;
    double calcCivilSunrise() const;
    double calcCivilSunset() const;
    double calcAstronomicalSunrise() const;
    double calcAstronomicalSunset() const;
    double calcCustomSunrise(double) const;
    double calcCustomSunset(double) const;
    [[deprecated("UTC specific calls may not be supported in the future")]] double calcSunriseUTC();
    [[deprecated("UTC specific calls may not be supported in the future")]] double calcSunsetUTC();
    double calcSunrise() const;
    double calcSunset() const;
    int moonPhase(int) const;
    int moonPhase() const;
    
private:
    double degToRad(double) const;
    double radToDeg(double) const;
    double calcMeanObliquityOfEcliptic(double) const;
    double calcGeomMeanLongSun(double) const;
    double calcObliquityCorrection(double) const;
    double calcEccentricityEarthOrbit(double) const;
    double calcGeomMeanAnomalySun(double) const;
    double calcEquationOfTime(double) const;
    double calcTimeJulianCent(double) const;
    double calcSunTrueLong(double) const;
    double calcSunApparentLong(double) const;
    double calcSunDeclination(double) const;
    double calcHourAngleSunrise(double, double, double) const;
    double calcHourAngleSunset(double, double, double) const;
    double calcJD(int,int,int) const;
    double calcJDFromJulianCent(double) const;
    double calcSunEqOfCenter(double) const;
    double calcAbsSunrise(double) const;
    double calcAbsSunset(double) const;
 
    double m_latitude;
    double m_longitude;
    double m_julianDate;
    double m_tzOffset;
    int m_year;
    int m_month;
    int m_day;
};
 
#endif