stella.adapter
Class GuidingUnit

java.lang.Object
  util.PropertyContainer
      util.PropertyResources
          util.PropertyBundles
              stella.adapter.AdapterUnit
                  stella.adapter.GuidingUnit

All Implemented Interfaces:

Cloneable, Initializable, LocalizedSupplying, PropertySupplying, ResourceSupplying

Direct Known Subclasses:

BeamSplitterGuider, SpillageGuider

public abstract class GuidingUnit
extends AdapterUnit

A guiding unit has the ability to keep an instrument fine alligned during the exposure. Normally this is done with a helper CCD by keeping the target star alligned at a crosshair..

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.URLResource

Field Summary

protected boolean	allowswitch If true, the guider is allowed to request a guider mode change.
protected double	increase A value set from the outside signaling increased exposure time.
static String	KEY_SEEING Issued to the local parameter cluster as the seeing estimate.
static String	KEY_WINDMAX The wind-speed maxometer parameter.
static String	MODE_AUTO Auto mode, select best as you think...
static String	MODE_NORMAL Normal guider mode.
static String	MODE_SEEING Bad seeing guider mode.
static String	MODE_TRACKING No-guiding mode, pure tracking.
static String	MODE_WIND High wind guider mode.
protected DataOutputStream	offrecord An object output stream were we serialize our alt/az offs in.
protected DataOutputStream	pidrecord An object output stream were we serialize our alt/az offs in.

Fields inherited from class stella.adapter.AdapterUnit

ACQUIRETYPE, GUIDERTYPE, PYRAMIDTYPE

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.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

protected

GuidingUnit(Map<String,String> p)

Method Summary

protected abstract TimerTask	createGuiderLoop(long repeatperiod) Creates the guider loop, which can be used as a timer task.
protected abstract long	getExposureTime() Returns the guider exposure time, available after unit task.
protected abstract GuiderMode	getMode() Returns the currently active guider mode.
protected abstract void	requestMode(String mode) Requests the guiding mode as the identifier string.
protected void	setAllowSwitch(boolean modechange) Sets the state of the allow switch.
protected void	setIncrease(double afteracquire) Sets the increase value.
protected void	setOffsetStream(DataOutputStream open) Sets a stream that should be used to serialize the offset data into.
protected void	setPIDStream(DataOutputStream open) Sets a stream that should be used to serialize the pids data into.

Methods inherited from class stella.adapter.AdapterUnit

doUnitTask, getGuider, getMaster, getTelescope, getUnitType, isManual, isValid, resetUnit, setGuider, setManual, setMaster, setTelescope

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, init, 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, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface util.ResourceSupplying

getResource, getResourceAsStream, getResources

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

MODE_AUTO

public static final String MODE_AUTO

Auto mode, select best as you think...

See Also:

Constant Field Values

MODE_NORMAL

public static final String MODE_NORMAL

Normal guider mode.

See Also:

Constant Field Values

MODE_SEEING

public static final String MODE_SEEING

Bad seeing guider mode.

See Also:

Constant Field Values

MODE_WIND

public static final String MODE_WIND

High wind guider mode.

See Also:

Constant Field Values

MODE_TRACKING

public static final String MODE_TRACKING

No-guiding mode, pure tracking.

See Also:

Constant Field Values

KEY_SEEING

public static final String KEY_SEEING

Issued to the local parameter cluster as the seeing estimate.

See Also:

Constant Field Values

KEY_WINDMAX

public static final String KEY_WINDMAX

The wind-speed maxometer parameter.

See Also:

Constant Field Values

increase

protected double increase

A value set from the outside signaling increased exposure time.

allowswitch

protected boolean allowswitch

If true, the guider is allowed to request a guider mode change.

offrecord

protected DataOutputStream offrecord

An object output stream were we serialize our alt/az offs in.

pidrecord

protected DataOutputStream pidrecord

An object output stream were we serialize our alt/az offs in.

Constructor Detail

GuidingUnit

protected GuidingUnit(Map<String,String> p)

Method Detail

setIncrease

protected void setIncrease(double afteracquire)

Sets the increase value.

setAllowSwitch

protected void setAllowSwitch(boolean modechange)

Sets the state of the allow switch. If this is true, the guider may issue request to change the guiding mode.

setOffsetStream

protected void setOffsetStream(DataOutputStream open)

Sets a stream that should be used to serialize the offset data into.

setPIDStream

protected void setPIDStream(DataOutputStream open)

Sets a stream that should be used to serialize the pids data into.

getExposureTime

protected abstract long getExposureTime()

Returns the guider exposure time, available after unit task.

createGuiderLoop

protected abstract TimerTask createGuiderLoop(long repeatperiod)

Creates the guider loop, which can be used as a timer task. This method must be called after the unit task was done without an error, and piped to the adapter masters timer. For the benefit of knowing the guider period, the adapter master hands over the period in ms at which the task will be scheduled.

requestMode

protected abstract void requestMode(String mode)

Requests the guiding mode as the identifier string.

getMode

protected abstract GuiderMode getMode()

Returns the currently active guider mode.