1/*
2 This file is part of the kholidays library.
3
4 Copyright (c) 2012 Allen Winter <winter@kde.org>
5
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
10
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
15
16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA.
20*/
21
22#ifndef KHOLIDAYS_SUNRISESET_H
23#define KHOLIDAYS_SUNRISESET_H
24
25#include "kholidays_export.h"
26#include <QTime>
27
28namespace KHolidays {
29
30/**
31 @brief
32 Methods for determining the sunrise and sunset times for a given date and Earth location.
33*/
34
35namespace SunRiseSet {
36
37 /**
38 Compute the sunrise time (UTC) for a date and Earth location.
39 @param date is any valid QDate.
40 @param latitude is a floating point representing a valid latitude (-90.0, 90.0)
41 @param longitude is a floating point representing a valid longitude (-180.0, 180.0)
42 @return the QTime of the sunrise in UTC.
43
44 @note the latitude and longitude are truncated as needed to fit into their proper range.
45
46 */
47 KHOLIDAYS_EXPORT QTime utcSunrise( const QDate &date, double latitude, double longitude );
48
49 /**
50 Compute the sunset time (UTC) for a date and Earth location.
51 @param date is any valid QDate.
52 @param latitude is a floating point representing a valid latitude (-90.0, 90.0)
53 @param longitude is a floating point representing a valid longitude (-180.0, 180.0)
54 @return the QTime of the sunset in UTC.
55
56 @note the latitude and longitude are truncated as needed to fit into their proper range.
57 */
58 KHOLIDAYS_EXPORT QTime utcSunset( const QDate &date, double latitude, double longitude );
59
60}
61
62}
63
64#endif
65