stella
Interface ErrorDependingParameter

All Superinterfaces:

Initializable, Parameter, PropertySupplying

All Known Subinterfaces:

StatusRequesting

All Known Implementing Classes:

AbstractStatusRequestor, AltTelescope, AzTelescope, ErrorTrigger, ExposureCount, ExposureTimeLeft, FlatGroup, FlatQuality, FluxAdapter, FocusMeasure, FocusPosition, FocusQuality, FrameProvider, FwhmAdapter, MirrorTemperature, ObservableList, PowerTelescope, RankProvider, RemoteSensorAverage, RemoteSensorMaximum, RemoteSensorStatistic, SensorStatistic, SnapshotParameter, SnapshotValue, StatisticValue, StatisticValue.Average, StatisticValue.Maximum, StatisticValue.Median, StatisticValue.Minimum, TelescopeError, TrackTime, Unique

public interface ErrorDependingParameter
extends Parameter

An error depending parameter can define its value only after an ErrorEvent instance has been registered to it. A possible application may be linked to parameters that re passed to the SCS via status messages. It appears useful to only pass error messages with the pipe flag on to the error depending parameter. To follow the same approach as in the TargetDependingParameter interface, two possiblities of data retrieval are possible: Either providing the error event directly on the #getFor method, or registering it with registerError(stella.ErrorEvent) and subsequentially calling Parameter.get().
Due to the dependency on errors, setting the parameter with the Parameter.set(java.lang.Object) method seems unlikely. Parameter values change with the receipt of an error event.
To allow the identification of error depending parameters, the specific NAMING_EXTENSION may be used for applications that must use the parameter in its error related sense, i.e. if an application may query a parameter not for its current setting, but for a setup of a special error (which, of course, this application must know of). The use of this extension is very unlikely, compared to the use of the naming extension in the TargetDependingParameter.

Field Summary

static String

NAMING_EXTENSION The naming extension to declare a target depending parameter.

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Method Summary

Object	getForError(ErrorEvent error) Returns the parameter value using some sensors of the weather surveying handed over.
void	registerError(ErrorEvent error) Registers a weather surveyor permanently to this parameter.

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

Field Detail

NAMING_EXTENSION

static final String NAMING_EXTENSION

The naming extension to declare a target depending parameter.

See Also:

Constant Field Values

Method Detail

getForError

Object getForError(ErrorEvent error)

Returns the parameter value using some sensors of the weather surveying handed over. Subsequent calls to Parameter.get() link to identical sensors.

registerError

void registerError(ErrorEvent error)

Registers a weather surveyor permanently to this parameter. All subsequent calls to the parameter's Parameter.get() method will refer to this weather station.