globals.value

Class SolHeight

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.value.AbstractValue

globals.value.SolHeight

All Implemented Interfaces:

Decreasing, Increasing, Parameter, ParameterDepending, Value, Cloneable, ExitCleaning, Initializable, PropertySupplying, Reloadable, ResourceSupplying

public class SolHeight
extends AbstractValue
implements Increasing, Decreasing, ParameterDepending, Reloadable

A Value calculating the solar zenith height. Four other globals must be registered, SolRa, SolDec, SiderealTime, and Latitude.

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
private static String	DEFLATITUDE The default name of the latitude parameter to use.
static String	DEFNAME The default name of this value.
static double	DEFRISETWILIGHT The default z solar toggle value.
static double	DEFSETTWILIGHT The default z solar toggle value.
private static String	DEFSIDEREAL The default name of the sidereal parameter to use.
private static String	DEFSOLDEC The default name of the solar declination to use.
private static String	DEFSOLRA The default name of the solar right ascension to use.
static String	KEY_LATITUDE The name of the latitude to use.
static String	KEY_SIDEREAL The name of the sidereal time to use.
static String	KEY_SOLDEC The name of the solar declination to use.
static String	KEY_SOLRA The name of the solar right ascension to use.
private Value	latitude The longitude of Teide, degrees.
private Value	sidereal The actual sidereal time.
private Value	soldec The solar declination parameter to use.
private Value	solra The solar right ascension parameter to use.

Fields inherited from class globals.parameter.AbstractParameter

KEY_FORMAT, KEY_NAME, KEY_PRESERVE, UNKNOWN

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

Constructors

Constructor and Description
SolHeight(Map<String,String> info) Constructs a new sidereal time object.

Method Summary

Modifier and Type	Method and Description
Long	getAscendTime(Number hsol) Returns the remaining time in ms until the sun rises to the specified height.
Number	getDerivative() Returns the derivative of the solar height with time in seconds.
Long	getDescendTime(Number hsol) Returns the remaining time in ms.
String	getFormatted() Returns the formatted solz value.
Number	getValue() Returns the actual height of the sun over the horizon.
void	registerParameter(Parameter what) Registers the required additional globals for the sidereal time.
double	rescanned(String key, String old, String newval) As any parameter depending instance we fail if the parameter we depend on is now a different one.
Number	setValue(Number val) Sets the sidereal time.

Methods inherited from class globals.value.AbstractValue

get, set

Methods inherited from class globals.parameter.AbstractParameter

createParameter, delivers, exit, getFormatted, getName, getPreserveFile, getString, getString, init, overrideDefaultName, register, setName, toString

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, isNew, parseObject, parseObject, reload, removeProperty, requires, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface util.Reloadable

reload

Methods inherited from interface globals.Parameter

getName, getString

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Methods inherited from interface util.Initializable

init

Field Detail

KEY_SIDEREAL

public static final String KEY_SIDEREAL

The name of the sidereal time to use.

See Also:

Constant Field Values

KEY_LATITUDE

public static final String KEY_LATITUDE

The name of the latitude to use.

See Also:

Constant Field Values

KEY_SOLRA

public static final String KEY_SOLRA

The name of the solar right ascension to use.

See Also:

Constant Field Values

KEY_SOLDEC

public static final String KEY_SOLDEC

The name of the solar declination to use.

See Also:

Constant Field Values

DEFNAME

public static final String DEFNAME

The default name of this value.

See Also:

Constant Field Values

DEFSIDEREAL

private static final String DEFSIDEREAL

The default name of the sidereal parameter to use.

See Also:

Constant Field Values

DEFLATITUDE

private static final String DEFLATITUDE

The default name of the latitude parameter to use.

See Also:

Constant Field Values

DEFSOLRA

private static final String DEFSOLRA

The default name of the solar right ascension to use.

See Also:

Constant Field Values

DEFSOLDEC

private static final String DEFSOLDEC

The default name of the solar declination to use.

See Also:

Constant Field Values

DEFRISETWILIGHT

public static final double DEFRISETWILIGHT

The default z solar toggle value.

See Also:

Constant Field Values

DEFSETTWILIGHT

public static final double DEFSETTWILIGHT

The default z solar toggle value.

See Also:

Constant Field Values

latitude

private Value latitude

The longitude of Teide, degrees.

sidereal

private Value sidereal

The actual sidereal time.

solra

private Value solra

The solar right ascension parameter to use.

soldec

private Value soldec

The solar declination parameter to use.

Constructor Detail

SolHeight

public SolHeight(Map<String,String> info)

Constructs a new sidereal time object. Note that this global can only function correctly after the time and longitude have been registered.

Method Detail

setValue

public Number setValue(Number val)
                throws UnsupportedOperationException

Sets the sidereal time. The sidereal time is a read-only variable, therefore this method throws an UnsupportedOperationException.

Specified by:

setValue in interface Value

Throws:

UnsupportedOperationException

getValue

public Number getValue()

Returns the actual height of the sun over the horizon. For convenience, the returned value is in degrees not in radians. If either of the three parameters denoting the sidereal time, the latitude of the site or the ecliptical longitude of the sun is missing, null is returned.

Specified by:

getValue in interface Value

getDerivative

public Number getDerivative()

Returns the derivative of the solar height with time in seconds.

rescanned

public double rescanned(String key,
                        String old,
                        String newval)

As any parameter depending instance we fail if the parameter we depend on is now a different one.

Specified by:

rescanned in interface Reloadable

Overrides:

rescanned in class AbstractParameter

registerParameter

public void registerParameter(Parameter what)

Registers the required additional globals for the sidereal time. For this particular object, latitude and UT is required. Note that the argumental global is checked for being of instance types of CurrentTime or Longitude, rather than querrying for the global name.

Specified by:

registerParameter in interface ParameterDepending

getAscendTime

public Long getAscendTime(Number hsol)

Returns the remaining time in ms until the sun rises to the specified height. For the ascend the solution of the hour angle that satisfies dh/dt>0 is used to derive the remaining time. The solar position is considered immutable.

Specified by:

getAscendTime in interface Increasing

Parameters:

hsol - The value in the future.

Returns:

A double carrying the remaining time or null if the time cannot be calculated.

getDescendTime

public Long getDescendTime(Number hsol)

Returns the remaining time in ms. For the descend the solution of the hour angle that satisfies dh/dt<0 is used to derive the remaining time. The solar position is considered inmutable.

Specified by:

getDescendTime in interface Decreasing

Parameters:

hsol - The value in the future.

Returns:

A double carrying the remaining time or null if the time cannot be calculated.

getFormatted

public String getFormatted()

Returns the formatted solz value. It is a string giving the solar z in deg, min, and sec.

Specified by:

getFormatted in interface Parameter

Overrides:

getFormatted in class AbstractParameter