KHolidays::SunRiseSet

KHolidays::SunRiseSet Namespace Reference

Functions

KHOLIDAYS_EXPORT bool isPolarDay (const QDate &date, double latitude)
 
KHOLIDAYS_EXPORT bool isPolarNight (const QDate &date, double latitude)
 
KHOLIDAYS_EXPORT bool isPolarTwilight (const QDate &date, double latitude)
 
KHOLIDAYS_EXPORT QTime utcDawn (const QDate &date, double latitude, double longitude)
 
KHOLIDAYS_EXPORT QTime utcDusk (const QDate &date, double latitude, double longitude)
 
KHOLIDAYS_EXPORT QTime utcSunrise (const QDate &date, double latitude, double longitude)
 
KHOLIDAYS_EXPORT QTime utcSunset (const QDate &date, double latitude, double longitude)
 

Detailed Description

Methods for determining the sunrise and sunset times for a given date and Earth location.

Function Documentation

◆ isPolarDay()

bool KHolidays::SunRiseSet::isPolarDay ( const QDate & date,
double latitude )

Checks whether it is polar day on day date at latitude.

That is, the sun stays above -0.83° relative to the horizon at all times. Both sunrise/sunset and dawn/dusk times will be invalid for such a day.

Parameters
latitudein degree (-90.0, 90.0)
See also
isPolarNight(), isPolarTwilight()
https://en.wikipedia.org/wiki/Midnight_sun
Since
5.97

Definition at line 215 of file sunriseset.cpp.

◆ isPolarNight()

bool KHolidays::SunRiseSet::isPolarNight ( const QDate & date,
double latitude )

Checks whether it is polar night on day date at latitude.

That is, the sun stays below -6° relative to the horizon at all times. Both sunrise/sunset and dawn/dusk times will be invalid for such a day.

Parameters
latitudein degree (-90.0, 90.0)
See also
isPolarDay(), isPolarTwilight()
https://en.wikipedia.org/wiki/Polar_night
Since
5.97

Definition at line 233 of file sunriseset.cpp.

◆ isPolarTwilight()

bool KHolidays::SunRiseSet::isPolarTwilight ( const QDate & date,
double latitude )

Checks whether it is polar twilight on day date at latitude.

That is, the sun rises at least above -6° relative the horizon during the day, but remains below -0.83° at all times. Sunrise/sunset times will be invalid for such a day, but dawn/dusk times will be available.

Parameters
latitudein degree (-90.0, 90.0)
See also
isPolarDay(), isPolarNight()
https://en.wikipedia.org/wiki/Polar_night
Since
5.97

Definition at line 224 of file sunriseset.cpp.

◆ utcDawn()

QTime KHolidays::SunRiseSet::utcDawn ( const QDate & date,
double latitude,
double longitude )

Compute the civil dawn time (UTC) for a date and Earth location.

Parameters
dateis any valid QDate.
latitudeis a floating point representing a valid latitude (-90.0, 90.0)
longitudeis a floating point representing a valid longitude (-180.0, 180.0)
See also
https://en.wikipedia.org/wiki/Twilight
Returns
the QTime of the sunrise in UTC.
Note
the latitude and longitude are truncated as needed to fit into their proper range.
Since
5.77

Definition at line 204 of file sunriseset.cpp.

◆ utcDusk()

QTime KHolidays::SunRiseSet::utcDusk ( const QDate & date,
double latitude,
double longitude )

Compute the civil dawn time (UTC) for a date and Earth location.

Parameters
dateis any valid QDate.
latitudeis a floating point representing a valid latitude (-90.0, 90.0)
longitudeis a floating point representing a valid longitude (-180.0, 180.0)
See also
https://en.wikipedia.org/wiki/Twilight
Returns
the QTime of the sunset in UTC.
Note
the latitude and longitude are truncated as needed to fit into their proper range.
Since
5.77

Definition at line 209 of file sunriseset.cpp.

◆ utcSunrise()

QTime KHolidays::SunRiseSet::utcSunrise ( const QDate & date,
double latitude,
double longitude )

Compute the sunrise time (UTC) for a date and Earth location.

Parameters
dateis any valid QDate.
latitudeis a floating point representing a valid latitude (-90.0, 90.0)
longitudeis a floating point representing a valid longitude (-180.0, 180.0)
Returns
the QTime of the sunrise in UTC.
Note
the latitude and longitude are truncated as needed to fit into their proper range.

Definition at line 194 of file sunriseset.cpp.

◆ utcSunset()

QTime KHolidays::SunRiseSet::utcSunset ( const QDate & date,
double latitude,
double longitude )

Compute the sunset time (UTC) for a date and Earth location.

Parameters
dateis any valid QDate.
latitudeis a floating point representing a valid latitude (-90.0, 90.0)
longitudeis a floating point representing a valid longitude (-180.0, 180.0)
Returns
the QTime of the sunset in UTC.
Note
the latitude and longitude are truncated as needed to fit into their proper range.

Definition at line 199 of file sunriseset.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 11 2024 12:17:52 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.