stella.adapter

Class AdapterUnit

java.lang.Object

util.PropertyContainer

util.PropertyResources

stella.adapter.AdapterUnit

All Implemented Interfaces:

Cloneable, Initializable, PropertySupplying, ResourceSupplying

Direct Known Subclasses:

AcquiringUnit, FocussingUnit, GuidingUnit

public abstract class AdapterUnit
extends PropertyResources
implements Initializable

The base class for adapter master sub-units that use the guider-ccd in some way. Methods exist for checking consitancy. Currently, a FocusUnit, a AcquireUnit and a GuiderUnit exits.

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACQUIRETYPE Acquire frames start with this header, followed by date and count.
private AbstractStarGuider	guider The image-processing unit.
static String	GUIDERTYPE Guiding frames start with this header, followed by date and count.
private boolean	manual If true, we are in manual mode and do not generate status events.
private AdapterMaster	master The reference to the master.
static String	PYRAMIDTYPE Guiding frames start with this header, followed by date and count.
private OffsetCaster	telescope The communicator to send offset commands.

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

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

Constructors

Modifier	Constructor and Description
protected	AdapterUnit(Map<String,String> prop) No default settings.

Method Summary

Modifier and Type	Method and Description
protected abstract ErrorEvent	doUnitTask(String mode) Commits the task of this unit.
protected AbstractStarGuider	getGuider() Get the adapter helper that can be used for calculating image-realted quantities.
protected AdapterMaster	getMaster() Returns the adapter master registered to this unit.
protected OffsetCaster	getTelescope() Get the telescope communication.
protected abstract String	getUnitType() Returns the type of this unit.
void	init()
protected boolean	isManual() Returns the manual status, normally inherited from the adapter master.
protected boolean	isValid() Checks if all the required quantities are set and non-null.
protected void	resetUnit() Resets the unit.
protected void	setGuider(AbstractStarGuider calculus) Sets the adapter helper who knows everything image related.
protected void	setManual(boolean nostatus) Sets manual mode, in which case we should not send status event, but rather use syslog.
protected void	setMaster(AdapterMaster chef) Sets the adapter master.
protected void	setTelescope(OffsetCaster sendto) Set the telescope communication.

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, 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, parseObject, reload, removeProperty, requires, 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.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

Field Detail

ACQUIRETYPE

public static final String ACQUIRETYPE

Acquire frames start with this header, followed by date and count.

See Also:

Constant Field Values

GUIDERTYPE

public static final String GUIDERTYPE

Guiding frames start with this header, followed by date and count.

See Also:

Constant Field Values

PYRAMIDTYPE

public static final String PYRAMIDTYPE

Guiding frames start with this header, followed by date and count.

See Also:

Constant Field Values

manual

private boolean manual

If true, we are in manual mode and do not generate status events.

telescope

private OffsetCaster telescope

The communicator to send offset commands.

guider

private AbstractStarGuider guider

The image-processing unit.

master

private AdapterMaster master

The reference to the master.

Constructor Detail

AdapterUnit

protected AdapterUnit(Map<String,String> prop)

No default settings.

Method Detail

init

public void init()
          throws InitException

Specified by:

init in interface Initializable

Throws:

InitException

setManual

protected void setManual(boolean nostatus)

Sets manual mode, in which case we should not send status event, but rather use syslog.

isManual

protected boolean isManual()

Returns the manual status, normally inherited from the adapter master.

setTelescope

protected void setTelescope(OffsetCaster sendto)

Set the telescope communication.

getTelescope

protected OffsetCaster getTelescope()

Get the telescope communication. If isValid() returns true, this will never return null.

resetUnit

protected void resetUnit()

Resets the unit. This is done only on first start of target, not at each restart, as we than lose the targetcounts.

setGuider

protected void setGuider(AbstractStarGuider calculus)

Sets the adapter helper who knows everything image related.

setMaster

protected void setMaster(AdapterMaster chef)

Sets the adapter master.

getMaster

protected AdapterMaster getMaster()

Returns the adapter master registered to this unit.

getGuider

protected AbstractStarGuider getGuider()

Get the adapter helper that can be used for calculating image-realted quantities. If isValid() returns true, this will never return null.

isValid

protected boolean isValid()

Checks if all the required quantities are set and non-null.

doUnitTask

protected abstract ErrorEvent doUnitTask(String mode)

Commits the task of this unit. All relevant information must be available to this object before commencing this call. This method may not return a status event, those generated should be sent immediately.

Parameters:

mode - If the unit supports more than a single mode, otherwise null

Returns:

null on okay, or an ErrorEvent desribing the failure.

getUnitType

protected abstract String getUnitType()

Returns the type of this unit.