KHolidays::LunarPhase

KHolidays::LunarPhase Class Reference

#include <lunarphase.h>

Public Types

enum  Phase {
  NewMoon, FirstQuarter, LastQuarter, FullMoon,
  None
}
 

Static Public Member Functions

static Phase phaseAtDate (const QDate &date)
 
static QString phaseName (Phase phase)
 
static QString phaseNameAtDate (const QDate &date)
 

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, https://en.wikipedia.org/wiki/Lunar_phase

Note that crescent and gibbous phases are not currently supported.

Definition at line 42 of file lunarphase.h.

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().

Enumerator
NewMoon 

New moon phase.

FirstQuarter 

First quarter of moon phase.

LastQuarter 

Last quarter of moon phase.

FullMoon 

Full moon phase.

None 

Indication for error.

Definition at line 50 of file lunarphase.h.

Member Function Documentation

LunarPhase::Phase LunarPhase::phaseAtDate ( const QDate date)
static

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
datecompute the lunar phase for the specified Gregorian date.

Definition at line 45 of file lunarphase.cpp.

QString LunarPhase::phaseName ( LunarPhase::Phase  phase)
static

Return the string representation of phase.

Parameters
phasethe lunar phase.

Definition at line 28 of file lunarphase.cpp.

QString LunarPhase::phaseNameAtDate ( const QDate date)
static

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
datecompute the lunar phase for the specified Gregorian date.

Definition at line 23 of file lunarphase.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Jun 4 2020 22:33:47 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.