stella.parameter
Class SiderealTime

java.lang.Object
  extended by util.PropertyContainer
      extended by util.PropertyResources
          extended by util.PropertyBundles
              extended by stella.parameter.AbstractParameter
                  extended by stella.parameter.AbstractValue
                      extended by stella.parameter.SiderealTime
All Implemented Interfaces:
Cloneable, Parameter, Increasing<Number>, ParameterDepending, Value, ExitCleaning, Initializable, LocalizedSupplying, PropertySupplying, Reloadable, ResourceSupplying

public class SiderealTime
extends AbstractValue
implements Increasing<Number>, ParameterDepending, Reloadable

And yet another implementation of a sidereal time computation. This time we follow the general Value contract. Therefore, two other globals must be registered, Time and Longitude.

This is a very simple sidereal time algorithmus (linear in time) which may proove to be unsatisfying for the STELLA purpose.


Nested Class Summary
static class SiderealTime.Now
          Reads the first command line argument and parses it into a date.
 
Nested classes/interfaces inherited from class util.PropertyResources
PropertyResources.URLResource
 
Field Summary
private static double[] CONST
          Constants required for the algorithm.
private static String DEFLONGITUDE
          The name of this global (sidereal).
static String DEFNAME
          The name of this global (sidereal).
private static String DEFTIME
          The name of this global (sidereal).
static String KEY_LONGITUDE
          The name of the latitude to use.
static String KEY_TIME
          The name of the latitude to use.
private  Value longitude
          The longitude of Teide, degrees.
private  Value time
          The UT time in ms.
 
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
SiderealTime(Map<String,String> info)
          Constructs a new sidereal time object.
 
Method Summary
 Double getAscendTime(Number until)
          Returns the remaining time in ms.
 String getFormatted()
          Returns a formatted version of the sidereal time.
static double getLocalApparentSiderealTime(double jd, double lamdeg)
          Returns the apparent local sidereal time for the given jd and the given longitude, return value is in degrees.
 Number getValue()
          Returns the sidereal time in degrees, wrapped into 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 stella.parameter.AbstractValue
get, set
 
Methods inherited from class stella.parameter.AbstractParameter
createParameter, delivers, exit, 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
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_LONGITUDE

public static final String KEY_LONGITUDE
The name of the latitude to use.

See Also:
Constant Field Values

KEY_TIME

public static final String KEY_TIME
The name of the latitude to use.

See Also:
Constant Field Values

DEFNAME

public static final String DEFNAME
The name of this global (sidereal).

See Also:
Constant Field Values

DEFLONGITUDE

private static final String DEFLONGITUDE
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

CONST

private static final double[] CONST
Constants required for the algorithm.


time

private Value time
The UT time in ms.


longitude

private Value longitude
The longitude of Teide, degrees.

Constructor Detail

SiderealTime

public SiderealTime(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 sidereal time in degrees, wrapped into a Double. Note that this method returns null if either the globals denoting the time or the Teide longitude are missing.

Specified by:
getValue in interface Value

getLocalApparentSiderealTime

public static double getLocalApparentSiderealTime(double jd,
                                                  double lamdeg)
Returns the apparent local sidereal time for the given jd and the given longitude, return value is in degrees.


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

getAscendTime

public Double getAscendTime(Number until)
Returns the remaining time in ms.

Specified by:
getAscendTime in interface Increasing<Number>
Parameters:
until - 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 a formatted version of the sidereal time.

Specified by:
getFormatted in interface Parameter
Overrides:
getFormatted in class AbstractParameter