Package gda.device.diffractometer.newport

Interface INewportVMCController

All Superinterfaces:

Configurable, Findable, Stoppable

All Known Implementing Classes:

DummyNewportVMCController, NewportVMCController

public interface INewportVMCController
extends Configurable, Findable, Stoppable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	INewportVMCController.Mode
static enum	INewportVMCController.Status

Method Summary

Modifier and Type	Method	Description
boolean	checkAnyCommandSafe(String command)
INewportVMCController.Status	cmdClearBuffer()	Clear command buffer
INewportVMCController.Status	cmdPauseOnNext()	Pause after current command finishes
INewportVMCController.Status	cmdResume()	Resume executing command buffer
INewportVMCController.Status	cmdStopAll()	Stop immediately and clear command buffer
void	configure()	Perform operations that must be done after Spring initialisation i.e.
void	executeSafeRoute()
String	getBufferCount()
String	getBufferList()
String	getBufferNext()
int	getCommandPort()
SocketConnection	getCommandSocketConnection()
int	getDetDistanceIndex()
String	getHost()
int	getKappaIndex()
String	getLastError()
String	getLastExecutedCommand()
void	getMechanicalPositions()
INewportVMCController.Mode	getMode()
String	getName()	Get the object name.
int	getOmegaIndex()
int	getPhiIndex()
Double	getPosition(int axisIndex)
String	getPositionAll()
String	getSafeRouteFile()
INewportVMCController.Status	getStatus()
int	getStatusPort()
SocketConnection	getStatusSocketConnection()
int	getTwoThetaIndex()
void	initialise()
boolean	isBusy()
boolean	isCommandBufferEmpty()
boolean	isReady()
void	moveAll(Object position)
void	moveAxis(int axisIndex, Object position)
void	moveAxisRelative(int axisIndex, Object position)
void	scanContinuous(int axisIndex, Double start, Double width, Double time)
void	setCommandPort(int port)
void	setCommandSocketConnection(SocketConnection socketConnection)
void	setDetDistanceIndex(int detDistanceIndex)
void	setHost(String host)
void	setKappaIndex(int kappaIndex)
void	setMode(INewportVMCController.Mode mode)
void	setModeCheckMove()
void	setModeCheckOnly()
void	setName(String name)	Set or change the name of the object (as defined in XML).
void	setOmegaIndex(int omegaIndex)
void	setPhiIndex(int phiIndex)
void	setStatusPort(int statusPort)
void	setStatusSocketConnection(SocketConnection statusSocketConnection)
void	setTwoThetaIndex(int twoThetaIndex)

Methods inherited from interface gda.factory.Configurable

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Stoppable

stop

Method Details

checkAnyCommandSafe

boolean checkAnyCommandSafe(String command)
                     throws DeviceException

Throws:

DeviceException

configure

void configure()
        throws FactoryException

Description copied from interface: Configurable

Perform operations that must be done after Spring initialisation i.e. anything that goes beyond setting member variables.

Specified by:

configure in interface Configurable

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

executeSafeRoute

void executeSafeRoute()
               throws DeviceException

Throws:

DeviceException

getCommandPort

int getCommandPort()

getCommandSocketConnection

SocketConnection getCommandSocketConnection()

getDetDistanceIndex

int getDetDistanceIndex()

getHost

String getHost()

getKappaIndex

int getKappaIndex()

getLastError

String getLastError()

getLastExecutedCommand

String getLastExecutedCommand()

getMechanicalPositions

void getMechanicalPositions()
                     throws DeviceException

Throws:

DeviceException

getMode

INewportVMCController.Mode getMode()

getName

String getName()

Description copied from interface: Findable

Get the object name. Used by Castor to check if the object name has been set before calling the Findable.setName(String) method.

Specified by:

getName in interface Findable

Returns:

a String containing the object name.

getOmegaIndex

int getOmegaIndex()

getPhiIndex

int getPhiIndex()

getBufferCount

String getBufferCount()

Returns:

number of commands remaining be executed in buffer

getBufferNext

String getBufferNext()

Returns:

next command to be executed in buffer

getBufferList

String getBufferList()

Returns:

semi-colon separated list of unexecuted commands remaining in buffer

getPosition

Double getPosition(int axisIndex)

getPositionAll

String getPositionAll()

getSafeRouteFile

String getSafeRouteFile()
                 throws DeviceException

Throws:

DeviceException

getStatus

INewportVMCController.Status getStatus()
                                throws DeviceException

Throws:

DeviceException

getStatusPort

int getStatusPort()

getStatusSocketConnection

SocketConnection getStatusSocketConnection()

getTwoThetaIndex

int getTwoThetaIndex()

initialise

void initialise()
         throws DeviceException

Throws:

DeviceException

isBusy

boolean isBusy()
        throws DeviceException

Throws:

DeviceException

isCommandBufferEmpty

boolean isCommandBufferEmpty()
                      throws DeviceException

Throws:

DeviceException

isReady

boolean isReady()
         throws DeviceException

Throws:

DeviceException

moveAll

void moveAll(Object position)
      throws DeviceException

Throws:

DeviceException

moveAxis

void moveAxis(int axisIndex,
 Object position)
       throws DeviceException

Throws:

DeviceException

moveAxisRelative

void moveAxisRelative(int axisIndex,
 Object position)
               throws DeviceException

Throws:

DeviceException

scanContinuous

void scanContinuous(int axisIndex,
 Double start,
 Double width,
 Double time)
             throws DeviceException

Throws:

DeviceException

setCommandPort

void setCommandPort(int port)

setCommandSocketConnection

void setCommandSocketConnection(SocketConnection socketConnection)

setDetDistanceIndex

void setDetDistanceIndex(int detDistanceIndex)

setHost

void setHost(String host)

setKappaIndex

void setKappaIndex(int kappaIndex)

setMode

void setMode(INewportVMCController.Mode mode)
      throws DeviceException

Throws:

DeviceException

setModeCheckMove

void setModeCheckMove()
               throws DeviceException

Throws:

DeviceException

setModeCheckOnly

void setModeCheckOnly()
               throws DeviceException

Throws:

DeviceException

setName

void setName(String name)

Description copied from interface: Findable

Set or change the name of the object (as defined in XML).

Specified by:

setName in interface Findable

Parameters:

name - the object name

setOmegaIndex

void setOmegaIndex(int omegaIndex)

setPhiIndex

void setPhiIndex(int phiIndex)

setStatusPort

void setStatusPort(int statusPort)

setStatusSocketConnection

void setStatusSocketConnection(SocketConnection statusSocketConnection)

setTwoThetaIndex

void setTwoThetaIndex(int twoThetaIndex)

cmdClearBuffer

INewportVMCController.Status cmdClearBuffer()
                                     throws DeviceException

Clear command buffer

Returns:

status

Throws:

DeviceException

cmdPauseOnNext

INewportVMCController.Status cmdPauseOnNext()
                                     throws DeviceException

Pause after current command finishes

Returns:

status

Throws:

DeviceException

cmdResume

INewportVMCController.Status cmdResume()
                                throws DeviceException

Resume executing command buffer

Returns:

status

Throws:

DeviceException

cmdStopAll

INewportVMCController.Status cmdStopAll()
                                 throws DeviceException

Stop immediately and clear command buffer

Returns:

status

Throws:

DeviceException