stella.parameter
Class TrackVelocity

java.lang.Object
  extended by util.PropertyContainer
      extended by util.PropertyResources
          extended by util.PropertyBundles
              extended by stella.parameter.AbstractParameter
                  extended by stella.parameter.AbstractTargetParameter
                      extended by stella.parameter.AbstractTargetValue
                          extended by stella.parameter.TrackVelocity
All Implemented Interfaces:
Cloneable, Parameter, TargetDependingValue, ParameterDepending, TargetDepending, TargetDependingParameter, Value, ExitCleaning, Initializable, LocalizedSupplying, PropertySupplying, Reloadable, ResourceSupplying

public class TrackVelocity
extends AbstractTargetValue
implements ParameterDepending, Reloadable

A class to calculate the tracking velocity as the sum of AzVelocity and AltVelocity.


Nested Class Summary
 
Nested classes/interfaces inherited from class util.PropertyResources
PropertyResources.URLResource
 
Field Summary
private  TargetDependingParameter altvel
          The altitude velocity of the target, degree/s.
private  TargetDependingParameter azvel
          The azimuth velocity of the target, degree/s.
private static String DEFALTVELOCITY
          The default name of the latitude parameter to use.
private static String DEFAZVELOCITY
          The default name of the solar ecliptical longitude to use.
static String DEFNAME
          The default name of this value.
private static DecimalFormat df
          The formatter for the target height.
static String KEY_ALTVELOCITY
          The name of the altitude velocity to use.
static String KEY_AZVELOCITY
          The name of the azimuth velocity to use.
 
Fields inherited from class stella.parameter.AbstractTargetParameter
KEY_INDEX
 
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
TrackVelocity(Map info)
          Constructs a new airmass target object.
 
Method Summary
private  Double calculate(Number azv, Number altv)
          Calculates the airmass using the hour angle and the declination of the target.
 Number getForTarget(TargetDefinition star)
          Gets the declination of the target star.
 Number getValue()
          Returns the target's actual airmass, wrapped into a Double.
 void registerParameter(Parameter what)
          Registers the required additional globals for the tracking velocity.
 void registerTarget(TargetDefinition star)
          Registers a star to this parameter.
 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 airmass of the actual target.
 
Methods inherited from class stella.parameter.AbstractTargetValue
get, set
 
Methods inherited from class stella.parameter.AbstractTargetParameter
getAsStar, getConstant, getFormattedFor, getSetup
 
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.TargetDependingParameter
getFormattedFor
 
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_ALTVELOCITY

public static final String KEY_ALTVELOCITY
The name of the altitude velocity to use.

See Also:
Constant Field Values

KEY_AZVELOCITY

public static final String KEY_AZVELOCITY
The name of the azimuth velocity to use.

See Also:
Constant Field Values

DEFNAME

public static final String DEFNAME
The default name of this value.

See Also:
Constant Field Values

DEFALTVELOCITY

private static final String DEFALTVELOCITY
The default name of the latitude parameter to use.

See Also:
Constant Field Values

DEFAZVELOCITY

private static final String DEFAZVELOCITY
The default name of the solar ecliptical longitude to use.

See Also:
Constant Field Values

azvel

private TargetDependingParameter azvel
The azimuth velocity of the target, degree/s.


altvel

private TargetDependingParameter altvel
The altitude velocity of the target, degree/s.


df

private static final DecimalFormat df
The formatter for the target height.

Constructor Detail

TrackVelocity

public TrackVelocity(Map info)
Constructs a new airmass target object. Note that this global can only function correctly after the tau and dec of the target and the teide latitude 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 airmass of the actual target. This is a read-only variable, therefore this method throws an UnsupportedOperationException.

Specified by:
setValue in interface Value
Throws:
UnsupportedOperationException

getForTarget

public Number getForTarget(TargetDefinition star)
Gets the declination of the target star.

Specified by:
getForTarget in interface TargetDependingValue
Specified by:
getForTarget in interface TargetDependingParameter
Returns:
A Double holding the target star's declination.

getValue

public Number getValue()
Returns the target's actual airmass, wrapped into a Double. Note that this method returns null if either of the globals denoting the tau, dec of the target or the latitude is missing.

Specified by:
getValue in interface Value

registerParameter

public void registerParameter(Parameter what)
Registers the required additional globals for the tracking velocity. For this parameter, the tracking velocity in altitude and azimuth is required.

Specified by:
registerParameter in interface ParameterDepending

registerTarget

public void registerTarget(TargetDefinition star)
Registers a star to this parameter. The target definition is directly passed to the azvel and altvel reference of this parameter. Note that this will set the target in the additional parameter, too.

Specified by:
registerTarget in interface TargetDepending

calculate

private Double calculate(Number azv,
                         Number altv)
Calculates the airmass using the hour angle and the declination of the target. The latitude of the site must be registered first.