SunriseSunset.h

Go to the documentation of this file.

#ifndef LIBOSMSCOUT_SUNRISESUNSET_H
#define LIBOSMSCOUT_SUNRISESUNSET_H
 
/*
  Sunrise Sunset Calculator.
  inspired by Java implementation https://github.com/caarmen/SunriseSunset (LGPL-2.1 License)
 
  This source is part of the libosmscout library
 
  Copyright (C) 2013-2017 Carmen Alvarez
  Copyright (C) 2021 Lukáš Karas
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library 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
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*/
 
#include <osmscout/lib/CoreImportExport.h>
#include <osmscout/GeoCoord.h>
#include <osmscout/system/Compiler.h>
#include <osmscout/system/Math.h>
#include <osmscout/util/Time.h>
#include <osmscout/util/String.h>
#include <osmscout/util/SunriseSunset.h>
 
#include <optional>
#include <string>
 
namespace osmscout {
 
  using SunriseSunsetRes=std::optional<std::tuple<Timestamp, Timestamp>>;

  extern OSMSCOUT_API SunriseSunsetRes GetSunriseSunset(const GeoCoord &location, const Timestamp &day, double sunAltitude);

  extern OSMSCOUT_API SunriseSunsetRes GetCivilTwilight(const GeoCoord &location, const Timestamp &day = Timestamp::clock::now());

  extern OSMSCOUT_API SunriseSunsetRes GetNauticalTwilight(const GeoCoord &location, const Timestamp &day = Timestamp::clock::now());

  extern OSMSCOUT_API SunriseSunsetRes GetAstronomicalTwilight(const GeoCoord &location, const Timestamp &day = Timestamp::clock::now());
 

  extern OSMSCOUT_API SunriseSunsetRes GetSunriseSunset(const GeoCoord &location, const Timestamp &day = Timestamp::clock::now());
 
}
 
#endif //LIBOSMSCOUT_SUNRISESUNSET_H