Package gda.server.collisionAvoidance

Class CollisionCheckerBase

java.lang.Object

gda.factory.FindableBase

gda.server.collisionAvoidance.CollisionCheckerBase

All Implemented Interfaces:

Findable, CollisionChecker

public abstract class CollisionCheckerBase
extends FindableBase
implements CollisionChecker

Constructor Summary

Constructors

Constructor	Description
CollisionCheckerBase()

Method Summary

Modifier and Type	Method	Description
abstract String[]	checkConfigurationPermitted(Double[] position)
String[]	checkMove(Double[] _currentRangeStart, Double[] _currentRangeEnd, Double[] _requestedConfiguration)	Checks to see if a move is safe.
String[]	getParamNames()
Double[]	getSampleSize()
void	setParamNames(String[] paramNames)
void	setSampleSize(Double[] sampleSize)
abstract String	toString()

Methods inherited from class gda.factory.FindableBase

equals, getName, hashCode, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface gda.factory.Findable

getName, setName

Constructor Details

CollisionCheckerBase

public CollisionCheckerBase()

Method Details

checkMove

public String[] checkMove(Double[] _currentRangeStart,
 Double[] _currentRangeEnd,
 Double[] _requestedConfiguration)
                   throws CacException

Description copied from interface: CollisionChecker

Checks to see if a move is safe. This will be called by the CAC with which the checker will have been registered.

Specified by:

checkMove in interface CollisionChecker

Parameters:

_currentRangeStart - Each value will be either the corresponding field's current position or, if the field is moving, the position where it began its move.

_currentRangeEnd - Each value will be null unless the field is moving, when it will be the position where it should finish its move.

_requestedConfiguration - The requested final position. NOTE: currently some values are allowed to by None, this will be removed ASAP.

Returns:

Null if the move is allowed, otherwise a string describing why it is not.

Throws:

CacException

getSampleSize

public Double[] getSampleSize()

Returns:

the sample size

setSampleSize

public void setSampleSize(Double[] sampleSize)
                   throws CacException

Parameters:

sampleSize -

Throws:

CacException

getParamNames

public String[] getParamNames()

Returns:

list of parameter names

setParamNames

public void setParamNames(String[] paramNames)

Parameters:

paramNames - the partameter names

checkConfigurationPermitted

public abstract String[] checkConfigurationPermitted(Double[] position)

Parameters:

position -

Returns:

null if okay, else string with reason.

toString

public abstract String toString()

Overrides:

toString in class Object