stella.parameter
Class RMagTarget

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

All Implemented Interfaces:

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

public class RMagTarget
extends AbstractTargetValue
implements Settable, ParameterDepending, Reloadable

A general variable representing the R magnitude of the actual object. Extends the AbstractValue base class. This paramters can be set directly or its value may be deduced from the visual magnitude and the B-V color index using the formular:

         R = V - 0.5(B-V)
   

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.URLResource

Field Summary

private TargetDependingParameter	bv The parameter depicitng the color index B-V of the target.
private static String	DEFBV The default R mag parameter name of the star.
static String	DEFNAME The name of this global (ra).
private static String	DEFVMAG The default V mag parameter name of the star.
private static DecimalFormat	df The formatter for the visual magnitude.
static String	KEY_BV The key to the name of the B-V color index of the star.
static String	KEY_VMAG The key to the name of the V magnitude of the star.
private Float	r The B-V color index of the actual object as a Float.
private TargetDependingParameter	v The parameter depicitng the visual magnitude of the target.

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

RMagTarget(Map prop)
Constructs a new global representing the actual object's v mag.

Method Summary

private static Float	fromVandBV(float vmag, float col) Returns an estimated R magnitude, given the visual magnitude and the B-V color index.
Number	getForTarget(TargetDefinition star) Gets the declination of the target star.
Number	getValue() Returns the R magnitude of the actual target.
void	registerParameter(Parameter what) Registers the required additional globals for the R magnitude.
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 r mag of the actual object.

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_VMAG

public static final String KEY_VMAG

The key to the name of the V magnitude of the star.

See Also:

Constant Field Values

KEY_BV

public static final String KEY_BV

The key to the name of the B-V color index of the star.

See Also:

Constant Field Values

DEFNAME

public static final String DEFNAME

The name of this global (ra).

See Also:

Constant Field Values

DEFVMAG

private static final String DEFVMAG

The default V mag parameter name of the star.

See Also:

Constant Field Values

DEFBV

private static final String DEFBV

The default R mag parameter name of the star.

See Also:

Constant Field Values

r

private Float r

The B-V color index of the actual object as a Float.

v

private TargetDependingParameter v

The parameter depicitng the visual magnitude of the target.

bv

private TargetDependingParameter bv

The parameter depicitng the color index B-V of the target.

df

private static final DecimalFormat df

The formatter for the visual magnitude.

Constructor Detail

RMagTarget

public RMagTarget(Map prop)

Constructs a new global representing the actual object's v mag.

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)

Sets the r mag of the actual object.

Specified by:

setValue in interface Value

Parameters:

val - A Float representing the brightness of the object, in mags.

Throws:

IllegalArgumentException - If the argument is not a Float.

registerParameter

public void registerParameter(Parameter what)

Registers the required additional globals for the R magnitude. The R magnitude may be set directly via a call to setValue(java.lang.Number) or it may be deduced from the visual magnitude and the color index. The direct method has precedence.

Specified by:

registerParameter in interface ParameterDepending

registerTarget

public void registerTarget(TargetDefinition star)

Registers a star to this parameter. The brightness 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 B-V color index

getValue

public Number getValue()

Returns the R magnitude of the actual target. If the magnitude was set directly with the setValue(java.lang.Number) method, this value has precedence over the indirect method using the visual magnitude and the B-V color index

Specified by:

getValue in interface Value

fromVandBV

private static final Float fromVandBV(float vmag,
                                      float col)

Returns an estimated R magnitude, given the visual magnitude and the B-V color index. The formular used is:
R = V - 0.5(B-V)