stella.parameter
Class FluxAdapter

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.FluxAdapter
All Implemented Interfaces:
Cloneable, ErrorDependingParameter, Parameter, Value, ExitCleaning, Initializable, LocalizedSupplying, PropertySupplying, Reloadable, ResourceSupplying

public class FluxAdapter
extends AbstractValue
implements ErrorDependingParameter, Reloadable

A parameter that utilizes incoming AdapterFwhm status messages to derive the reported star flux (in instrumental magnitudes) out of it.


Nested Class Summary
 
Nested classes/interfaces inherited from class util.PropertyResources
PropertyResources.URLResource
 
Field Summary
static String DEFNAME
          The default name of the adapter flux.
private  Double flux
          The current focus position.
 
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 stella.ErrorDependingParameter
NAMING_EXTENSION
 
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
FluxAdapter(Map prop)
          Constructs a new adapter flux value.
 
Method Summary
 Object getForError(ErrorEvent ee)
          Scans the AdapterFwhm for the flux and returns it as a Double object
 Number getValue()
          Gets the last reported flux of a star image obtained during centering or guiding on the adapter.
 void registerError(ErrorEvent ee)
          Registers this adapter fwhm event to the parameter.
 double rescanned(String key, String old, String newval)
          Makes this method public, no further changes.
 Number setValue(Number newval)
          Sets the flux of the star image.
 
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 stella.Parameter
get, getFormatted, getName, getString, set
 
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.Reloadable
reload
 
Methods inherited from interface util.ResourceSupplying
getResource, getResourceAsStream, getResources
 

Field Detail

DEFNAME

public static final String DEFNAME
The default name of the adapter flux.

See Also:
Constant Field Values

flux

private Double flux
The current focus position.

Constructor Detail

FluxAdapter

public FluxAdapter(Map prop)
Constructs a new adapter flux value. The name is defaulted.

Method Detail

rescanned

public double rescanned(String key,
                        String old,
                        String newval)
Makes this method public, no further changes.

Specified by:
rescanned in interface Reloadable
Overrides:
rescanned in class AbstractParameter

getForError

public Object getForError(ErrorEvent ee)
Scans the AdapterFwhm for the flux and returns it as a Double object

Specified by:
getForError in interface ErrorDependingParameter
Returns:
null If the error event passed over is not an adapter fwhm.

registerError

public void registerError(ErrorEvent ee)
Registers this adapter fwhm event to the parameter.

Specified by:
registerError in interface ErrorDependingParameter

getValue

public Number getValue()
Gets the last reported flux of a star image obtained during centering or guiding on the adapter. The number is identically to the flux value transported in the AdapterFwhm object.

Specified by:
getValue in interface Value

setValue

public Number setValue(Number newval)
Sets the flux of the star image. Probably only needed for setting after error retrieval or for debugging issues.

Specified by:
setValue in interface Value