ISpin

All Superinterfaces:: Configurable, Device, Findable, gda.observable.IObservable, Scannable

All Known Implementing Classes:: DummySpinner, Spin, Spinner

public interface ISpin extends Scannable

ISpin Interface

Field Summary

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

double

getSpeed()

get spin speed

String

getState()

check spin state - i.e.

void

off()

disable spin or switch off spin

void

on()

enable spin or switch on spin

void

setSpeed(double speed)

set spin speed

Methods inherited from interface gda.factory.Configurable
configure, isConfigureAtStartup, isConfigured, reconfigure

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, waitWhileBusy

Method Details
- on
  
  void on() throws DeviceException
  
  enable spin or switch on spin
  
  Throws:
  
  DeviceException
- off
  
  void off() throws DeviceException
  
  disable spin or switch off spin
  
  Throws:
  
  DeviceException
- setSpeed
  
  void setSpeed(double speed) throws DeviceException
  
  set spin speed
  
  Parameters:
  
  speed -
  
  Throws:
  
  DeviceException
- getSpeed
  
  double getSpeed() throws DeviceException
  
  get spin speed
  
  Returns:
  
  spin speed
  
  Throws:
  
  DeviceException
- getState
  
  String getState() throws DeviceException
  
  check spin state - i.e. Enabled or Disabled
  
  Returns:
  
  spin state
  
  Throws:
  
  DeviceException