Package gda.device

Interface Robot

All Superinterfaces:

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

All Known Implementing Classes:

I11Robot

public interface Robot
extends Scannable

Robot 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
void	clearSample()	clear the sample from the sample stage and put it back onto carousel.
void	finish()	release the hold to enable "start" command again
String	getError()	gets the error code for engineer
double	getSamplePosition()	gets the actual sample position number in Robot
SampleState	getSampleState()	gets robot's sample state i.e.
void	nextSample()	fetches the next sample from the carousel and put it on sample stage.
void	nextSample(double n)	fetches the n'th sample from the carousel and put it on sample stage.
void	recover()	reset robot following interruption
void	start()	starts the robot control

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

start

void start()
    throws DeviceException

starts the robot control

Throws:

DeviceException

nextSample

void nextSample()
         throws DeviceException

fetches the next sample from the carousel and put it on sample stage.

Throws:

DeviceException

nextSample

void nextSample(double n)
         throws DeviceException

fetches the n'th sample from the carousel and put it on sample stage.

Parameters:

n -

Throws:

DeviceException

clearSample

void clearSample()
          throws DeviceException

clear the sample from the sample stage and put it back onto carousel.

Throws:

DeviceException

finish

void finish()
     throws DeviceException

release the hold to enable "start" command again

Throws:

DeviceException

getError

String getError()
         throws DeviceException

gets the error code for engineer

Returns:

error code

Throws:

DeviceException

recover

void recover()
      throws DeviceException

reset robot following interruption

Throws:

DeviceException

getSamplePosition

double getSamplePosition()
                  throws DeviceException

gets the actual sample position number in Robot

Returns:

the actual sample position number in Robot

Throws:

DeviceException

getSampleState

SampleState getSampleState()
                    throws DeviceException

gets robot's sample state i.e. where is the sample in relation to the robot.

Returns:

robot's sample state ie where is the sample in relation to the robot.

Throws:

DeviceException