stella
Interface Parameter

All Superinterfaces:

Initializable, PropertyBearing

All Known Subinterfaces:

AfterRegistering, DatabaseParameter, ErrorDependingParameter, ExposureTimeMeasuring, SocketParameter, StatePreserving, StatusRequesting, Switch, TargetDependingParameter, TargetDependingValue, Trigger, Value, WeatherDependingParameter, WeatherSurveying

All Known Implementing Classes:

AbstractCachedParameter, AbstractCCDParameter, AbstractCCDValue, AbstractDatabaseParameter, AbstractDatabaseValue, AbstractFitsMomentsValue, AbstractFitsParameter, AbstractFitsValue, AbstractParameter, AbstractRemoteParameter, AbstractRemoteSwitch, AbstractRemoteTrigger, AbstractRemoteValue, AbstractStatusRequestor, AbstractSwitch, AbstractTargetParameter, AbstractTargetValue, AbstractTrigger, AbstractValue, AbstractWeatherSurveyor, AcceleratedJd, AcceleratedTime, AirmassTarget, AlarmWatch, Altitude, AltTarget, AltTelescope, AltVelocity, AzTarget, AzTelescope, AzVelocity, BarycentricVelocity, Blinker, BVTarget, CabinetSwitch, CCDLn2Temp, CCDRefTemp, CCDTemp, ConstantOffset, CountDownTrigger, CountDownWatch, CountingTrigger, DataValue, DateFromJd, DecApparent, DecTarget, DerotatorCenter, DerotatorOffset, DeviceTrigger, Distance, Distance.TargetDistance, DitherParameter, DiurnalVelocity, EclipticObliquity, Efficiency, ElapsedTime, EnvironmentFocus, ErrorTrigger, ExposureCount, ExposureRepeat, ExposureSpan, ExposureTimeLeft, ExtinctionCoefficient, FilterTarget, FilterWavelength, FilterWheelPosition, FilterWidth, FitsMoments, FitsParameterStub, FlatExposureTime, FlatGroup, FlatMatch, FlatMaximumTime, FlatPointing, FlatQuality, FluxAdapter, FocusMeasure, FocusPosition, FocusQuality, FocusStar, FractionalExposureTime, FrameProvider, FwhmAdapter, HeadPressure, HjdCorrection, Horizon, HostAddress, HumiditySwitch, ImageRevolution, ImageRotation, ImageType, InferPark, IntegerId, Jd, JFrameParameter, JSliderParameter, Latitude, LightSwitch, Longitude, MirrorTemperature, MissmatchTrigger, MomentsTrigger, Moon, MoonAngle, MoonAzimuth, MoonDec, MoonHeight, MoonLight, MoonPhase, MoonRa, NasmithImageRevolution, NasmithImageRotation, NightClear, NightLength, NightRemain, ObservableList, Observing, OneReadTrigger, OneWireMultiSwitch, OneWireSwitch, ParameterSkeleton, ParameterStub, PilarParameter, PilarTrigger, PilarValue, PowerTelescope, PropDecTarget, PropRaTarget, RaApparent, RankProvider, RaTarget, RefractionModel, RemoteSensorAverage, RemoteSensorMaximum, RemoteSensorShelf, RemoteSensorStatistic, RemoteSensorStub, RemoteShelfAverage, RemoteShelfMaximum, RMagTarget, RollOverWatch, RoofTrigger, RS485Switch, SeasonWeather, SensorShelf, SensorStatistic, SensorValue, SerialValue, ServerPort, SettableTime, ShelfStatistic, ShelfStatistic.Average, ShelfStatistic.Maximum, ShelfStatistic.Minimum, ShelfStatistic.Test, ShelterTrigger, ShutterTimes, SiderealGreenwich, SiderealGreenwichApparent, SiderealTime, SignalToNoise, SimpleEventTrigger, SimpleParameter, SimpleRemoteSwitch, SimpleRemoteTrigger, SimpleRemoteValue, SimpleTrigger, SimpleValue, SimpleValue.Exposure, SimulatorWeather, SnapshotParameter, SnapshotValue, SolAzimuth, SolDec, SolDistance, SolHeight, SolLambda, SolOpposition, SolRa, SolSink, SolZ, StatisticValue, StatisticValue.Average, StatisticValue.Maximum, StatisticValue.Median, StatisticValue.Minimum, StopWatch, SubTargets, SumWatch, SwitchSkeleton, SwitchStub, SwitchTrigger, TargetCatalogName, TargetDistance, TargetFilterFunction, TargetFunction, TargetInstitution, TargetList, TargetMerit, TargetName, TargetSetup, TargetType, TargetUser, TauTarget, TelescopeError, Time, TrackTime, TrackVelocity, TriggerSkeleton, TriggerStub, Twilight, Unique, UserShare, ValueDifference, ValueFraction, ValueProduct, ValueStub, ValueSum, VMagTarget, WatchController, WcsString, WeatherRemainsBad, WeatherStation, WeatherTrigger, WeatherTrigger

public interface Parameter
extends PropertyBearing, Initializable

This interface defines querry routines for global variables. A global variable in the stella sense means anything that has an overall importance for all stella devices and can be represented by a single number. All global parameter should have a name that starts with a capital letter.
Please ensure that all concrete classes implementing this interface support a constructor with a Properties object as the only argument, see AbstractParameter. Prominent examples are

• Time: Actual time, Represented by a Long in ms since 1.1.1970
• RaTarget: Right ascension of the object, degrees.
• DecTarget: Declination of the object, degrees.
• TauTarget: Hour angle of the object, degrees.
• AirmassTarget: Airmass to the object, dimensionless Double.
• SiderealTime: Actual sidereal time, in degrees.
• Longitude: Longitude (of Teide Observatory), in degrees.
• Latitude: Latitude (of Teide Observatory), in degrees.

Note that some of these quantities are read-only. These parameters should throw an UnsupportedOperationException if the set(java.lang.Object) method is invoked.
Note also that some parameters need knowledge of some other parameters to properly return their value (e.g. TauObject needs RaObject and SiderealTime). This is accounted for via the ParameterDepending interface.

For remote access, see RemoteParameter.

A hierarchy of the parameters:

>   Latitude -----------+--+---------------------+
>   Longitude           |  |                     |
>     |                 |  |                     |
>     +-- SiderealTime ----+----------------+    |
>     |                 |  +-- NightRemain  |    |
>   Time                |  +-- SolZ         |    +--------+-- ZTarget
>     |                 |  |                |    |        |
>     +-- SolLambda -------+                +-- TauTarget |
>           |           |                   |             |
>   Jd      +----- NightLength              |             |
>   RaTarget -------------------------------+             |
>   DecTarget --------------------------------------------+
   

Field Summary

Fields inherited from interface util.PropertyBearing

CONFIG, KEY_CLASS, KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Method Summary

Object	get() Returns the value of this parameter as an object.
String	getFormatted() Returns a formatted representation of the parameter.
String	getName() Returns the unique name of this parameter.
String	getString() Returns the string representation of the parameter.
Object	set(Object val) Sets the value of this parameter.

Methods inherited from interface util.PropertyBearing

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getLocalized, getProperties, getProperty, getResource, getResourceAsStream, getResources, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Methods inherited from interface util.Initializable

init

Method Detail

get

Object get()

Returns the value of this parameter as an object.

set

Object set(Object val)
           throws UnsupportedOperationException

Sets the value of this parameter.

Returns:

The previous value of this parameter.

Throws:

UnsupportedOperationException - If this parameter is read-only.

getName

String getName()

Returns the unique name of this parameter.

getString

String getString()

Returns the string representation of the parameter.

getFormatted

String getFormatted()

Returns a formatted representation of the parameter. This can also be something that has no direct link to the parameter value retrieved with get(). It is intended for a representation that is human-readable.