Package gda.device

Interface ODCCD

All Superinterfaces:

Configurable, Detector, Device, Findable, gda.observable.IObservable, Scannable

All Known Implementing Classes:

ODCCDController

public interface ODCCD
extends Detector

Methods (additional to those of Device and Detector) required to control Oxford Detector CCD.

Field Summary

Fields inherited from interface gda.device.Detector

BUSY, FAULT, IDLE, MONITORING, PAUSED, STANDBY

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Method Summary

Modifier and Type	Method	Description
String	closeShutter()	Method to close the shutter.
void	connect(String host)	Connect to the IS software on remote host.
void	disconnect()	Use this method to disconnect from the IS software.
String	getDataName()	Returns the name of the last data read from the CCD.
boolean	isConnected()	Is the CCD control object connected to the CCD?
String	openShutter()	Method to open the shutter.
ODCCDImage	readDataFromISDataBase(String pathname)	Reads the data from an IS database node.
void	runScript(String command)	Use this method to call a user script on the IS host.
String	shutter()	Read the shutter status
double	temperature()	Read the CCD temperature.
double	waterTemperature()	Read the chiller unit water temperature.

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Detector

collectData, createsOwnFiles, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, getStatus, prepareForCollection, readout, setCollectionTime, waitWhileBusy

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.Scannable

asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString

Method Details

connect

void connect(String host)
      throws IOException

Connect to the IS software on remote host.

Parameters:

host - The remote host IS is running on.

Throws:

IOException

disconnect

void disconnect()

Use this method to disconnect from the IS software.

isConnected

boolean isConnected()

Is the CCD control object connected to the CCD?

Returns:

true or false

getDataName

String getDataName()

Returns the name of the last data read from the CCD.

Returns:

The data name.

temperature

double temperature()

Read the CCD temperature.

Returns:

The CCD temperature.

waterTemperature

double waterTemperature()

Read the chiller unit water temperature.

Returns:

The water temperature.

runScript

void runScript(String command)

Use this method to call a user script on the IS host. Example 1: call save_dark 1.0 2 \"d:/dark2.img\" Example 3: call dark_cor 10.0 2 "//root/Darks/"

Parameters:

command - The command to run on IS

shutter

String shutter()

Read the shutter status

Returns:

OPEN or CLOSED

openShutter

String openShutter()

Method to open the shutter. It returns the status of the shutter.

Returns:

OPEN

closeShutter

String closeShutter()

Method to close the shutter. It returns the status of the shutter.

Returns:

CLOSED

readDataFromISDataBase

ODCCDImage readDataFromISDataBase(String pathname)

Reads the data from an IS database node.

Parameters:

pathname - The location of the data

Returns:

The image data in a ODCCDImage object.