Package org.shredzone.commons.suncalc
Interface SunTimes.Parameters
- All Superinterfaces:
Builder<SunTimes>
,GenericParameter<SunTimes.Parameters>
,LocationParameter<SunTimes.Parameters>
,TimeParameter<SunTimes.Parameters>
- Enclosing class:
- SunTimes
public static interface SunTimes.Parameters
extends GenericParameter<SunTimes.Parameters>, LocationParameter<SunTimes.Parameters>, TimeParameter<SunTimes.Parameters>, Builder<SunTimes>
Collects all parameters for
SunTimes
.-
Method Summary
Modifier and TypeMethodDescriptiondefault SunTimes.Parameters
Computes until all rise, set, noon, and nadir times are found.Limits the calculation window to the givenDuration
.default SunTimes.Parameters
oneDay()
Limits the time window to the next 24 hours.twilight
(double angle) Sets the desired elevation angle of the sun.twilight
(SunTimes.Twilight twilight) Sets theSunTimes.Twilight
mode.Methods inherited from interface org.shredzone.commons.suncalc.param.GenericParameter
copy
Methods inherited from interface org.shredzone.commons.suncalc.param.LocationParameter
at, at, elevation, elevationFt, height, heightFt, latitude, latitude, longitude, longitude, sameLocationAs
-
Method Details
-
twilight
Sets theSunTimes.Twilight
mode.Defaults to
SunTimes.Twilight.VISUAL
.- Parameters:
twilight
-SunTimes.Twilight
mode to be used.- Returns:
- itself
-
twilight
Sets the desired elevation angle of the sun. The sunrise and sunset times are referring to the moment when the center of the sun passes this angle.- Parameters:
angle
- Geocentric elevation angle, in degrees.- Returns:
- itself
-
limit
Limits the calculation window to the givenDuration
.- Parameters:
duration
- Duration of the calculation window. Must be positive.- Returns:
- itself
- Since:
- 3.1
-
oneDay
Limits the time window to the next 24 hours.- Returns:
- itself
-
fullCycle
Computes until all rise, set, noon, and nadir times are found.This is the default.
- Returns:
- itself
-