globals.value

Class MoonPhase

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.value.AbstractValue

globals.value.MoonPhase

All Implemented Interfaces:

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

public class MoonPhase
extends AbstractValue
implements ParameterDepending, Reloadable

A class representing the current phase of the moon as seen from the earth. Uses the Moon parameter and returns the illuminated fraction between zero and one.

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	DEFMOON The default name of the solar ecliptical longitude to use.
static String	DEFNAME The default name of this parameter.
static String	KEY_MOON The name of the moon parameter.
private Parameter	moon The moon parameter.

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
MoonPhase(Map<String,String> prop) Constructs a new moon right ascension parameter.

Method Summary

Modifier and Type	Method and Description
Number	getValue() Returns the right ascension of the Moon in radians 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 monn right ascension.

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_MOON

public static final String KEY_MOON

The name of the moon parameter.

See Also:

Constant Field Values

DEFNAME

public static final String DEFNAME

The default name of this parameter.

See Also:

Constant Field Values

DEFMOON

private static final String DEFMOON

The default name of the solar ecliptical longitude to use.

See Also:

Constant Field Values

moon

private Parameter moon

The moon parameter.

Constructor Detail

MoonPhase

public MoonPhase(Map<String,String> prop)

Constructs a new moon right ascension parameter. Defaults the value of the moon parameter KEY_MOON.

Method Detail

setValue

public Number setValue(Number val)
                throws UnsupportedOperationException

Sets the monn right ascension. The right ascension 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 right ascension of the Moon in radians as a Double. Note that this method returns null if the globals denoting the solar longitude is missing.

Specified by:

getValue in interface Value

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