globals.value

Class SolDistance

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.value.AbstractValue

globals.value.SolDistance

All Implemented Interfaces:

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

public class SolDistance
extends AbstractValue
implements ParameterDepending, Reloadable

A Value calculating the apparent solar distance in AU. One additional globals must be registered, CurrentTime.
The algorithms are based on VSOP87 data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SolDistance.Test Testing only.

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFNAME The name of this global (sidereal).
private static String	DEFTIME The name of this global (sidereal).
static String	KEY_TIME The name of the time to use.
private Value	time The UT time in ms.

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
SolDistance(Map<String,String> info) Constructs a new sidereal time object.

Method Summary

Modifier and Type	Method and Description
static double	getSolDistance(long ms) Calculates the solar distance using VSOP in AU, given the time as a UNIX time stamp.
Number	getValue() Returns the ecliptical longitude of the Sun in degrees as a Double.
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, 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

getFormatted, 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_TIME

public static final String KEY_TIME

The name of the time to use.

See Also:

Constant Field Values

DEFNAME

public static final String DEFNAME

The name of this global (sidereal).

See Also:

Constant Field Values

DEFTIME

private static final String DEFTIME

The name of this global (sidereal).

See Also:

Constant Field Values

time

private Value time

The UT time in ms.

Constructor Detail

SolDistance

public SolDistance(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

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

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 ecliptical longitude of the Sun in degrees as a Double. Note that this method returns null if the globals denoting the time is missing.

Specified by:

getValue in interface Value

getSolDistance

public static final double getSolDistance(long ms)

Calculates the solar distance using VSOP in AU, given the time as a UNIX time stamp.

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