Package gda.device.diffractometer.newport

Class NewportVMCController

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.diffractometer.newport.NewportVMCController

All Implemented Interfaces:

Device, INewportVMCController, Stoppable, Configurable, Findable, gda.observable.IObservable

public class NewportVMCController
extends DeviceBase
implements INewportVMCController

Class to communicate with the Newport collision avoidance software

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	NewportVMCController.Response

Nested classes/interfaces inherited from interface gda.device.diffractometer.newport.INewportVMCController

INewportVMCController.Mode, INewportVMCController.Status

Field Summary

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Constructor Summary

Constructors

Constructor	Description
NewportVMCController()

Method Summary

Modifier and Type	Method	Description
boolean	checkAnyCommandSafe(String command)
void	closeConnection()
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()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
void	executeSafeRoute()
String	getBufferCount()
String	getBufferList()
String	getBufferNext()
int	getCommandPort()
SocketConnection	getCommandSocketConnection()
String	getCurrentCommand()
int	getDetDistanceIndex()
String	getHost()
int	getKappaIndex()
String	getLastError()
String	getLastExecutedCommand()
void	getMechanicalPositions()
INewportVMCController.Mode	getMode()
String	getName()	Get the name of the device
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	isControllerActioned()
boolean	isControllerBusy()
boolean	isControllerInError()
boolean	isControllerInState(INewportVMCController.Status state)
boolean	isReady()
boolean	isSendStatusFlag()
boolean	isStatusConnected()
boolean	isStoppingStatusFlag()
void	moveAll(Object position)
void	moveAxis(int axisIndex, Object position)
void	moveAxisRelative(int axisIndex, Object position)
INewportVMCController.Status	reset()
boolean	resetErrorState()
void	scanContinuous(int axisIndex, Double start, Double width, Double time)
NewportVMCController.Response	sendCommandSocketCommand(String command)
NewportVMCController.Response	sendSocketWaitResponse(SocketConnection socket, String command)
NewportVMCController.Response	sendStatusSocketCommand(String command)
void	setCommandPort(int port)
void	setCommandSocketConnection(SocketConnection socketConnection)
void	setDetDistanceIndex(int detDistanceIndex)
void	setHost(String host)
void	setKappaIndex(int kappaIndex)
void	setMaxWaitControllerBusy(double waitSeconds)
void	setMode(INewportVMCController.Mode mode)
void	setModeCheckMove()
void	setModeCheckOnly()
void	setName(String name)	Set the name of the device
void	setOmegaIndex(int omegaIndex)
void	setPhiIndex(int phiIndex)
void	setPollCommandInterval(long millis)
void	setPollCommandTrials(long numTrials)
void	setStatusPort(int statusPort)
void	setStatusSocketConnection(SocketConnection statusSocketConnection)
void	setTwoThetaIndex(int twoThetaIndex)
void	stop()	Stops the current operation.
void	waitUntilMoveRegistered(double timeoutInSeconds)	A short waitUntilBusy to allow the controller to transition from READY to TESTING on a move request
double	waitWhileControllerBusy(double timeoutInSeconds)	waitWhileBusy for the controller, with a timeout and will throws a DeviceException if the time limit is reached.
double	waitWhileControllerBusyDelay(double maxDelayInSeconds)	waitWhileBusy for the controller, to a maximum delay - no timeout exception.

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface gda.factory.Configurable

isConfigureAtStartup, isConfigured, reconfigure

Constructor Details

NewportVMCController

public NewportVMCController()

Method Details

checkAnyCommandSafe

public boolean checkAnyCommandSafe(String command)
                            throws DeviceException

Specified by:

checkAnyCommandSafe in interface INewportVMCController

Throws:

DeviceException

closeConnection

public void closeConnection()

cmdClearBuffer

public INewportVMCController.Status cmdClearBuffer()
                                            throws DeviceException

Description copied from interface: INewportVMCController

Clear command buffer

Specified by:

cmdClearBuffer in interface INewportVMCController

Returns:

status

Throws:

DeviceException

cmdPauseOnNext

public INewportVMCController.Status cmdPauseOnNext()
                                            throws DeviceException

Description copied from interface: INewportVMCController

Pause after current command finishes

Specified by:

cmdPauseOnNext in interface INewportVMCController

Returns:

status

Throws:

DeviceException

cmdResume

public INewportVMCController.Status cmdResume()
                                       throws DeviceException

Description copied from interface: INewportVMCController

Resume executing command buffer

Specified by:

cmdResume in interface INewportVMCController

Returns:

status

Throws:

DeviceException

cmdStopAll

public INewportVMCController.Status cmdStopAll()
                                        throws DeviceException

Description copied from interface: INewportVMCController

Stop immediately and clear command buffer

Specified by:

cmdStopAll in interface INewportVMCController

Returns:

status

Throws:

DeviceException

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Specified by:

configure in interface INewportVMCController

Overrides:

configure in class ConfigurableBase

Throws:

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

executeSafeRoute

public void executeSafeRoute()
                      throws DeviceException

Specified by:

executeSafeRoute in interface INewportVMCController

Throws:

DeviceException

getCommandPort

public int getCommandPort()

Specified by:

getCommandPort in interface INewportVMCController

getBufferCount

public String getBufferCount()

Specified by:

getBufferCount in interface INewportVMCController

Returns:

number of commands remaining be executed in buffer

getBufferList

public String getBufferList()

Specified by:

getBufferList in interface INewportVMCController

Returns:

semi-colon separated list of unexecuted commands remaining in buffer

getBufferNext

public String getBufferNext()

Specified by:

getBufferNext in interface INewportVMCController

Returns:

next command to be executed in buffer

getCommandSocketConnection

public SocketConnection getCommandSocketConnection()

Specified by:

getCommandSocketConnection in interface INewportVMCController

getCurrentCommand

public String getCurrentCommand()

getDetDistanceIndex

public int getDetDistanceIndex()

Specified by:

getDetDistanceIndex in interface INewportVMCController

getHost

public String getHost()

Specified by:

getHost in interface INewportVMCController

getKappaIndex

public int getKappaIndex()

Specified by:

getKappaIndex in interface INewportVMCController

getLastError

public String getLastError()

Specified by:

getLastError in interface INewportVMCController

getLastExecutedCommand

public String getLastExecutedCommand()

Specified by:

getLastExecutedCommand in interface INewportVMCController

getMechanicalPositions

public void getMechanicalPositions()
                            throws DeviceException

Specified by:

getMechanicalPositions in interface INewportVMCController

Throws:

DeviceException

getMode

public INewportVMCController.Mode getMode()

Specified by:

getMode in interface INewportVMCController

getName

public String getName()

Description copied from class: DeviceBase

Get the name of the device

Specified by:

getName in interface Findable

Specified by:

getName in interface INewportVMCController

Overrides:

getName in class DeviceBase

Returns:

Returns the name.

getOmegaIndex

public int getOmegaIndex()

Specified by:

getOmegaIndex in interface INewportVMCController

getPhiIndex

public int getPhiIndex()

Specified by:

getPhiIndex in interface INewportVMCController

getPosition

public Double getPosition(int axisIndex)

Specified by:

getPosition in interface INewportVMCController

getPositionAll

public String getPositionAll()

Specified by:

getPositionAll in interface INewportVMCController

getSafeRouteFile

public String getSafeRouteFile()
                        throws DeviceException

Specified by:

getSafeRouteFile in interface INewportVMCController

Throws:

DeviceException

getStatus

public INewportVMCController.Status getStatus()
                                       throws DeviceException

Specified by:

getStatus in interface INewportVMCController

Throws:

DeviceException

getStatusPort

public int getStatusPort()

Specified by:

getStatusPort in interface INewportVMCController

getStatusSocketConnection

public SocketConnection getStatusSocketConnection()

Specified by:

getStatusSocketConnection in interface INewportVMCController

getTwoThetaIndex

public int getTwoThetaIndex()

Specified by:

getTwoThetaIndex in interface INewportVMCController

initialise

public void initialise()
                throws DeviceException

Specified by:

initialise in interface INewportVMCController

Throws:

DeviceException

isBusy

public boolean isBusy()
               throws DeviceException

Specified by:

isBusy in interface INewportVMCController

Throws:

DeviceException

isCommandBufferEmpty

public boolean isCommandBufferEmpty()
                             throws DeviceException

Specified by:

isCommandBufferEmpty in interface INewportVMCController

Throws:

DeviceException

isControllerActioned

public boolean isControllerActioned()
                             throws DeviceException

Throws:

DeviceException

isControllerBusy

public boolean isControllerBusy()
                         throws DeviceException

Throws:

DeviceException

isControllerInError

public boolean isControllerInError()
                            throws DeviceException

Throws:

DeviceException

isControllerInState

public boolean isControllerInState(INewportVMCController.Status state)

isReady

public boolean isReady()
                throws DeviceException

Specified by:

isReady in interface INewportVMCController

Throws:

DeviceException

isSendStatusFlag

public boolean isSendStatusFlag()

isStatusConnected

public boolean isStatusConnected()

isStoppingStatusFlag

public boolean isStoppingStatusFlag()

moveAll

public void moveAll(Object position)
             throws DeviceException

Specified by:

moveAll in interface INewportVMCController

Throws:

DeviceException

moveAxis

public void moveAxis(int axisIndex,
 Object position)
              throws DeviceException

Specified by:

moveAxis in interface INewportVMCController

Throws:

DeviceException

moveAxisRelative

public void moveAxisRelative(int axisIndex,
 Object position)
                      throws DeviceException

Specified by:

moveAxisRelative in interface INewportVMCController

Throws:

DeviceException

reset

public INewportVMCController.Status reset()
                                   throws DeviceException

Throws:

DeviceException

resetErrorState

public boolean resetErrorState()

scanContinuous

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

Specified by:

scanContinuous in interface INewportVMCController

Throws:

DeviceException

sendCommandSocketCommand

public NewportVMCController.Response sendCommandSocketCommand(String command)

sendSocketWaitResponse

public NewportVMCController.Response sendSocketWaitResponse(SocketConnection socket,
 String command)

sendStatusSocketCommand

public NewportVMCController.Response sendStatusSocketCommand(String command)

setCommandPort

public void setCommandPort(int port)

Specified by:

setCommandPort in interface INewportVMCController

setCommandSocketConnection

public void setCommandSocketConnection(SocketConnection socketConnection)

Specified by:

setCommandSocketConnection in interface INewportVMCController

setDetDistanceIndex

public void setDetDistanceIndex(int detDistanceIndex)

Specified by:

setDetDistanceIndex in interface INewportVMCController

setHost

public void setHost(String host)

Specified by:

setHost in interface INewportVMCController

setKappaIndex

public void setKappaIndex(int kappaIndex)

Specified by:

setKappaIndex in interface INewportVMCController

setMode

public void setMode(INewportVMCController.Mode mode)
             throws DeviceException

Specified by:

setMode in interface INewportVMCController

Throws:

DeviceException

setMaxWaitControllerBusy

public void setMaxWaitControllerBusy(double waitSeconds)

setModeCheckMove

public void setModeCheckMove()
                      throws DeviceException

Specified by:

setModeCheckMove in interface INewportVMCController

Throws:

DeviceException

setModeCheckOnly

public void setModeCheckOnly()
                      throws DeviceException

Specified by:

setModeCheckOnly in interface INewportVMCController

Throws:

DeviceException

setName

public void setName(String name)

Description copied from class: DeviceBase

Set the name of the device

Specified by:

setName in interface Findable

Specified by:

setName in interface INewportVMCController

Overrides:

setName in class DeviceBase

Parameters:

name - The name to set.

setOmegaIndex

public void setOmegaIndex(int omegaIndex)

Specified by:

setOmegaIndex in interface INewportVMCController

setPhiIndex

public void setPhiIndex(int phiIndex)

Specified by:

setPhiIndex in interface INewportVMCController

setPollCommandInterval

public void setPollCommandInterval(long millis)

setPollCommandTrials

public void setPollCommandTrials(long numTrials)

setStatusPort

public void setStatusPort(int statusPort)

Specified by:

setStatusPort in interface INewportVMCController

setStatusSocketConnection

public void setStatusSocketConnection(SocketConnection statusSocketConnection)

Specified by:

setStatusSocketConnection in interface INewportVMCController

setTwoThetaIndex

public void setTwoThetaIndex(int twoThetaIndex)

Specified by:

setTwoThetaIndex in interface INewportVMCController

stop

public void stop()
          throws DeviceException

Description copied from interface: Stoppable

Stops the current operation.

Specified by:

stop in interface Stoppable

Throws:

DeviceException

waitUntilMoveRegistered

public void waitUntilMoveRegistered(double timeoutInSeconds)
                             throws InterruptedException,
DeviceException

A short waitUntilBusy to allow the controller to transition from READY to TESTING on a move request

Parameters:

timeoutInSeconds -

Throws:

DeviceException

InterruptedException

waitWhileControllerBusy

public double waitWhileControllerBusy(double timeoutInSeconds)
                               throws InterruptedException,
DeviceException

waitWhileBusy for the controller, with a timeout and will throws a DeviceException if the time limit is reached.

Parameters:

timeoutInSeconds -

Throws:

DeviceException

InterruptedException

waitWhileControllerBusyDelay

public double waitWhileControllerBusyDelay(double maxDelayInSeconds)
                                    throws InterruptedException,
DeviceException

waitWhileBusy for the controller, to a maximum delay - no timeout exception.

Parameters:

maxDelayInSeconds -

Throws:

InterruptedException

DeviceException