stella.parameter
Class TargetDistance

java.lang.Object
  util.PropertyContainer
      util.PropertyResources
          util.PropertyBundles
              stella.parameter.AbstractParameter
                  stella.parameter.AbstractTargetParameter
                      stella.parameter.AbstractTargetValue
                          stella.parameter.TargetDistance

All Implemented Interfaces:

Cloneable, Parameter, TargetDependingValue, ParameterDepending, TargetDepending, TargetDependingParameter, Value, ExitCleaning, Initializable, LocalizedSupplying, PropertySupplying, Reloadable, ResourceSupplying

public class TargetDistance
extends AbstractTargetValue
implements ParameterDepending, Reloadable

A parameter that calculates the distance of a target to some given fixed point in the sky. This parameter is a TargetDependingParameter, allowing proper calculation of the current target distance to i.e. the moon.

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.URLResource

Field Summary

private Value	de The declination of the first point.
static String	DEFNAME The name of this global (ra).
private static DecimalFormat	df The formatter for the distance.
private Double	dist The current distance after a star has been registered.
static String	KEY_DEC The name of the parameter that gives the dec of the first point.
static String	KEY_RA The name of the parameter that gives the ra of the first point.
static Map<String,String>	MOONDISTANCE Use this properties for distance of target to moon.
private Value	ra The right ascension of the first point.
static Map<String,String>	SOLDISTANCE Use this properties for distance of target to sun.

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

TargetDistance(Map prop)
Constructs a new global representing the actual object distance to some other point in the sky.

Method Summary

private Double	getDistance(double radeg, double dedeg) If a point in the sky has been registered, this method returns the distance to this point from the ra and dec in degrees.
Number	getForTarget(TargetDefinition star) Gets the declination of the target star.
Number	getValue() Returns the ra of the actual target.
void	registerParameter(Parameter what) Registers the parameters giving the ra, dec of two points.
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 distance.

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

MOONDISTANCE

public static final Map<String,String> MOONDISTANCE

Use this properties for distance of target to moon.

SOLDISTANCE

public static final Map<String,String> SOLDISTANCE

Use this properties for distance of target to sun.

KEY_RA

public static final String KEY_RA

The name of the parameter that gives the ra of the first point.

See Also:

Constant Field Values

KEY_DEC

public static final String KEY_DEC

The name of the parameter that gives the dec of the first point.

See Also:

Constant Field Values

DEFNAME

public static final String DEFNAME

The name of this global (ra).

See Also:

Constant Field Values

df

private static final DecimalFormat df

The formatter for the distance.

ra

private Value ra

The right ascension of the first point.

de

private Value de

The declination of the first point.

dist

private Double dist

The current distance after a star has been registered.

Constructor Detail

TargetDistance

public TargetDistance(Map prop)

Constructs a new global representing the actual object distance to some other point in the sky.

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

registerParameter

public void registerParameter(Parameter what)

Registers the parameters giving the ra, dec of two points. No checks for types are made, only the parameter name counts.

Specified by:

registerParameter in interface ParameterDepending

registerTarget

public void registerTarget(TargetDefinition star)

Registers a star to this parameter. The declination of the star is set as this parameter's value.

Specified by:

registerTarget in interface TargetDepending

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 ra of the actual target. Returns null if the ra has not been set previously.

Specified by:

getValue in interface Value

getDistance

private Double getDistance(double radeg,
                           double dedeg)

If a point in the sky has been registered, this method returns the distance to this point from the ra and dec in degrees.

setValue

public Number setValue(Number val)
                throws UnsupportedOperationException

Sets the distance. This is a read-only variable, therefore this method throws an UnsupportedOperationException.

Specified by:

setValue in interface Value

Throws:

UnsupportedOperationException