Package org.shredzone.commons.suncalc

Interface SunTimes.Parameters

All Superinterfaces:

Builder<SunTimes>, GenericParameter<SunTimes.Parameters>, LocationParameter<SunTimes.Parameters>, TimeParameter<SunTimes.Parameters>, TimeResultParameter<SunTimes.Parameters>

Enclosing class:

SunTimes

public static interface SunTimes.Parameters
extends GenericParameter<SunTimes.Parameters>, LocationParameter<SunTimes.Parameters>, TimeParameter<SunTimes.Parameters>, TimeResultParameter<SunTimes.Parameters>, Builder<SunTimes>

Collects all parameters for SunTimes.

Nested Class Summary

Nested classes/interfaces inherited from interface org.shredzone.commons.suncalc.param.TimeResultParameter

TimeResultParameter.Unit

Method Summary

Modifier and Type	Method	Description
SunTimes.Parameters	fullCycle()	Computes until rise and set times are found, even if the sun needs more than a day for it.
SunTimes.Parameters	oneDay()	Checks only the next 24 hours.
SunTimes.Parameters	twilight(double angle)	Sets the desired elevation angle of the sun.
SunTimes.Parameters	twilight(SunTimes.Twilight twilight)	Sets the SunTimes.Twilight mode.

Methods inherited from interface org.shredzone.commons.suncalc.param.Builder

execute

Methods inherited from interface org.shredzone.commons.suncalc.param.GenericParameter

copy

Methods inherited from interface org.shredzone.commons.suncalc.param.LocationParameter

at, at, height, latitude, latitude, longitude, longitude, sameLocationAs

Methods inherited from interface org.shredzone.commons.suncalc.param.TimeParameter

localTime, midnight, now, on, on, on, on, plusDays, sameTimeAs, timezone, timezone, today, tomorrow, utc

Methods inherited from interface org.shredzone.commons.suncalc.param.TimeResultParameter

truncatedTo

Method Details

twilight

SunTimes.Parameters twilight(SunTimes.Twilight twilight)

Sets the SunTimes.Twilight mode.

Defaults to SunTimes.Twilight.VISUAL.

Parameters:

twilight - SunTimes.Twilight mode to be used.

Returns:

itself

twilight

SunTimes.Parameters twilight(double angle)

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

oneDay

SunTimes.Parameters oneDay()

Checks only the next 24 hours. Rise or set time can be null if the sun never reaches the point during one day (e.g. at solstice).

This is the default.

Returns:

itself

fullCycle

SunTimes.Parameters fullCycle()

Computes until rise and set times are found, even if the sun needs more than a day for it. This can considerably increase computation time.

Returns:

itself