Zmanim.Calculator.IAstronomicalCalculator Interface Reference
A interface that defines the sservices needed to calculate sunrise and sunset. More...
Public Member Functions | |
| double | GetUtcSunrise (IAstronomicalCalendar astronomicalCalendar, double zenith, bool adjustForElevation) |
| A method that calculates UTC sunrise as well as any time based on an angle above or below sunrise. This abstract method is implemented by the classes that extend this class. | |
| double | GetUtcSunset (IAstronomicalCalendar astronomicalCalendar, double zenith, bool adjustForElevation) |
| A method that calculates UTC sunset as well as any time based on an angle above or below sunset. This abstract method is implemented by the classes that extend this class. | |
Properties | |
| string | CalculatorName [get] |
| A descriptive name of the algorithm. /summary> | |
Detailed Description
A interface that defines the sservices needed to calculate sunrise and sunset.
Member Function Documentation
| double Zmanim.Calculator.IAstronomicalCalculator.GetUtcSunrise | ( | IAstronomicalCalendar | astronomicalCalendar, | |
| double | zenith, | |||
| bool | adjustForElevation | |||
| ) |
A method that calculates UTC sunrise as well as any time based on an angle above or below sunrise. This abstract method is implemented by the classes that extend this class.
- Parameters:
-
astronomicalCalendar Used to calculate day of year. zenith the azimuth below the vertical zenith of 90 degrees. for sunrise typically the zenith used for the calculation uses geometric zenith of 90°; and adjusts this slightly to account for solar refraction and the sun's radius. Another example would be AstronomicalCalendar.GetBeginNauticalTwilight that passes AstronomicalCalendar.NAUTICAL_ZENITH to this method. adjustForElevation if set to true[adjust for elevation].
- Returns:
- The UTC time of sunrise in 24 hour format. 5:45:00 AM will return 5.75.0. If an error was encountered in the calculation (expected behavior for some locations such as near the poles, Double.NaN will be returned.
Implemented in Zmanim.Calculator.AstronomicalCalculator, Zmanim.Calculator.JSuntimeCalculator, Zmanim.Calculator.NOAACalculator, Zmanim.Calculator.SunTimesCalculator, and Zmanim.Calculator.ZmanimCalculator.
| double Zmanim.Calculator.IAstronomicalCalculator.GetUtcSunset | ( | IAstronomicalCalendar | astronomicalCalendar, | |
| double | zenith, | |||
| bool | adjustForElevation | |||
| ) |
A method that calculates UTC sunset as well as any time based on an angle above or below sunset. This abstract method is implemented by the classes that extend this class.
- Parameters:
-
astronomicalCalendar Used to calculate day of year. zenith the azimuth below the vertical zenith of 90°;. For sunset typically the zenith used for the calculation uses geometric zenith of 90°; and adjusts this slightly to account for solar refraction and the sun's radius. Another example would be AstronomicalCalendar.GetEndNauticalTwilight that passes AstronomicalCalendar.NAUTICAL_ZENITH to this method. adjustForElevation if set to true[adjust for elevation].
- Returns:
- The UTC time of sunset in 24 hour format. 5:45:00 AM will return 5.75.0. If an error was encountered in the calculation (expected behavior for some locations such as near the poles,
- See also:
- Double.NaN
Implemented in Zmanim.Calculator.AstronomicalCalculator, Zmanim.Calculator.JSuntimeCalculator, Zmanim.Calculator.NOAACalculator, Zmanim.Calculator.SunTimesCalculator, and Zmanim.Calculator.ZmanimCalculator.
The documentation for this interface was generated from the following file:
- D:/Projects/Zmanim/src/Zmanim/Calculator/IAstronomicalCalculator.cs
