KDE 4.1 API Reference libkholidays
LibKHolidays::LunarPhase Class Reference
#include <lunarphase.h>
Detailed Description
Represents and manages a Lunar Phase.A Lunar Phase can be one of the following:
+ "new": the moon is not visible; or traditionally: first visible crescent of the Moon. For religious purposes, the new month begins when the first crescent moon can be seen. Thus, it is impossible to be certain in advance of when months will begin; in particular, the exact date on which Ramadan will begin is not known in advance. In Saudi Arabia, observers are sent up in airplanes if the weather is cloudy when the new moon is expected. + "first quarter": the right 50% of the moon is visible. + "full": the moon is fully visible. + "last quarter": the left 50% of the moon is visible.
A very good description of the lunar phases can be read at the Wikipedia, http://en.wikipedia.org/wiki/Lunar_phase
Note that crescent and gibbous phases are not currently supported.
Definition at line 54 of file lunarphase.h.
Public Types | |
| enum | Phase { NewMoon, FirstQuarter, LastQuarter, FullMoon, None } |
Public Member Functions | |
| LunarPhase () | |
| Phase | phase (const QDate &date) const |
| QString | phaseStr (const QDate &date) const |
| ~LunarPhase () | |
Static Public Member Functions | |
| static QString | phaseName (Phase phase) |
Member Enumeration Documentation
Phases of the moon, in traditional English notation.
The phase None is used only as an error indicator, for instance in phase().
Definition at line 62 of file lunarphase.h.
Constructor & Destructor Documentation
| LunarPhase::LunarPhase | ( | ) |
| LunarPhase::~LunarPhase | ( | ) |
Member Function Documentation
| LunarPhase::Phase LunarPhase::phase | ( | const QDate & | date | ) | const |
Return the lunar phase for the specified Gregorian date.
The enum 'None' is returned if one of the supported phases does not occur on the date.
- Parameters:
-
date compute the lunar phase for the specified Gregorian date.
Definition at line 64 of file lunarphase.cpp.
| QString LunarPhase::phaseName | ( | LunarPhase::Phase | phase | ) | [static] |
Return the string representation of phase.
- Parameters:
-
phase the lunar phase.
Definition at line 47 of file lunarphase.cpp.
Return the lunar phase as a text string for the specified date.
A null string is returned if one of the supported phases does not occur on the date.
- Parameters:
-
date compute the lunar phase for the specified Gregorian date.
Definition at line 42 of file lunarphase.cpp.
The documentation for this class was generated from the following files:
