stella.parameter
Class SolSink

java.lang.Object
  util.PropertyContainer
      util.PropertyResources
          util.PropertyBundles
              stella.parameter.AbstractParameter
                  stella.parameter.AbstractValue
                      stella.parameter.SolSink

All Implemented Interfaces:

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

public class SolSink
extends AbstractValue
implements ParameterDepending, Reloadable

Gives the current speed of the sun-rise or sink, meaning the first derivative of the solar height with time. In particular this means that a negative value is returned from true midday to true midnight, after that a positive value is returned. Together with the solar height (which it depends on) this can be used to distinguish between dusk and dawn, which maight be important for skyflats.

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.URLResource

Field Summary

static String	DEFNAME The default name of this value.
private static String	DEFSOLHEIGHT The default name of the sidereal parameter to use.
static String	KEY_SOLHEIGHT The name of the solar height parameter to use.
private SolHeight	solalt The solar height in Tenerife, degrees.

Fields inherited from class stella.parameter.AbstractParameter

KEY_FORMAT, KEY_NAME, KEY_PRESERVE, UNKNOWN

Fields inherited from class util.PropertyBundles

KEY_LOCALECOUNTRY, KEY_LOCALELANGUAGE, KEY_RESOURCEBUNDLES

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, localurl, locate, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_URL, urlset

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

SolSink(Map<String,String> info)
Constructs a new sidereal time object.

Method Summary

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 stella.parameter.AbstractValue

get, set

Methods inherited from class stella.parameter.AbstractParameter

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

Methods inherited from class util.PropertyBundles

clone, getLocalized, getLocalized, getLocalizedString, getLocalizedString, loadResource

Methods inherited from class util.PropertyResources

createFrom, createFrom, createFrom, getApplet, getAsResources, getLocalClassLoader, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

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, reload, removeProperty, 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 stella.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

Methods inherited from interface util.ResourceSupplying

getResource, getResourceAsStream, getResources

Field Detail

KEY_SOLHEIGHT

public static final String KEY_SOLHEIGHT

The name of the solar height parameter to use.

See Also:

Constant Field Values

DEFNAME

public static final String DEFNAME

The default name of this value.

See Also:

Constant Field Values

DEFSOLHEIGHT

private static final String DEFSOLHEIGHT

The default name of the sidereal parameter to use.

See Also:

Constant Field Values

solalt

private SolHeight solalt

The solar height in Tenerife, degrees.

Constructor Detail

SolSink

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

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 Time or Longitude, rather than querrying for the global name.

Specified by:

registerParameter in interface ParameterDepending