stella.omc

Class OmcMotor

java.lang.Object

util.PropertyContainer

io.AbstractDriver

io.AbstractSerialDriver

stella.omc.MotorController

stella.omc.OmcMotor

All Implemented Interfaces:

Driver, Cloneable, Initializable, PropertySupplying

public class OmcMotor
extends MotorController

Extention of the MotorController class. Its aim is to provide a simple interface for the filter wheel operation. The two important method can set the wheel in its zero position and (then) in arbitrary position specified by the wholes in the wheel. The class has syslog capabilities through the protomatter syslog classes.

Nested Class Summary

Nested classes/interfaces inherited from class stella.omc.MotorController

MotorController.AxesReset, MotorController.Dump, MotorController.Reset, MotorController.Set, MotorController.Status, MotorController.Step

Nested classes/interfaces inherited from class io.AbstractSerialDriver

AbstractSerialDriver.Available

Field Summary

Fields

Modifier and Type	Field and Description
private static String	DEFAXIS The axis name.
static String	DEFDRIVERNAME Default driver name.
private static String	DEFPARAMETERS The default initializing parameters.
private MotorControllerException	e
static String	KEY_PARAMETERS The parameters to send on init as a map.
private boolean	overwriteProgram
private boolean	printCtrl

Fields inherited from class stella.omc.MotorController

axis, FAILED, HOME, KEY_ADDRESS, KEY_AXES, KEY_CONTROLLERTYPE, KEY_EEPROMSTORE, KEY_FAILAXISMOVE, KEY_PROTOCOL, KEY_RESPONSECHOP, KEY_RESPONSEDELAY, KEY_RETRYPOS, KEY_SERIALRETRY, KEY_SLEEPAXISMOVE, KEY_STEPTOLERANCE, KEY_TELEGRAM, KEY_WORKAROUND, MCC, OK, OMC, UNDEFINEDPOSITION

Fields inherited from class io.AbstractSerialDriver

inport, KEY_BAUDRATE, KEY_CLOSETIMEOUT, KEY_DATABIT, KEY_FLOWCONTROL, KEY_INBUFFER, KEY_NOTIFYCOOLDOWN, KEY_OUTBUFFER, KEY_PARITYBIT, KEY_PORTNAME, KEY_RECEIVEFRAMING, KEY_RECEIVETHRESHOLD, KEY_RECEIVETIMEOUT, KEY_STOPBIT, KEY_TIMEOUT, LOCK, outport, STATICLOCK

Fields inherited from class io.AbstractDriver

KEY_DRIVERNAME

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
OmcMotor(Map<String,String> config) Construct a new filter wheel similar to a motor controller, but defaulting its name to DEFDRIVERNAME.

Method Summary

Modifier and Type	Method and Description
String	cancelDownloadPrg() Cancels downloading the program.
private String	checkString(String str, int requiredLength) Check the length of a string and complete it with spaces to the required length if it is shorter, or throws IllegalArgumentException if the string is longer.
String	downloadPrg(String prgName) Downloads a program from the controller.
void	downloadPrg(String prgName, String fileName) Downloads a program from the controller and saves in a file.
protected double	getControllerParameter(String param)
protected double[]	getControllerParameterArray(int[] ipar) Returns the values of all parameters indicated in the list.
protected Map<String,String>	getParametersFor(String ax) We have only a single axis, thus, always return a single map.
protected int	getStepResolution()
boolean	isISOControl()
boolean	isProgramOverwriteable() Determines if the uploaded program should overwrite the existing one.
void	printISOControl(boolean answer) Whether or not the ISO control characters should be returned by sendCommand ().
void	reset() Resets the controller.
protected void	setControllerParameter(String param, int value)
void	setProgramOverwriteable(boolean answ) Sets whether or not the program is to be uploaded should overwrite the one in the controller if that already exists there.
void	uploadPrg(String prgName, String fileName, int autoStart) Uploads a program stored in a file to the controller.

Methods inherited from class stella.omc.MotorController

axisStop, encapsulate, ensureCommand, errorPower, errorStep, errorStop, getAxesNames, getControllerParameter, getControllerParameterArray, getControllerType, getStatus, getStatus, getStep, getStepResolution, init, isContinuous, open, powerOff, powerOn, readString, readString, remote, resetAxis, setControllerParameter, waitWhileAxisMoving, waitWhileAxisMoving, writeCommand, writeCommand, writeString, writeString

Methods inherited from class io.AbstractSerialDriver

close, createPortEventListener, createPortEventListener, deregisterSoleEventListener, disableEvent, enableEvent, getDriverName, isOpen, registerSoleEventListener, resetOriginalParameters

Methods inherited from class io.AbstractDriver

createDriver, equals, hashCode

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object

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

Field Detail

KEY_PARAMETERS

public static final String KEY_PARAMETERS

The parameters to send on init as a map.

See Also:

Constant Field Values

DEFDRIVERNAME

public static final String DEFDRIVERNAME

Default driver name.

See Also:

Constant Field Values

DEFAXIS

private static final String DEFAXIS

The axis name.

See Also:

Constant Field Values

DEFPARAMETERS

private static final String DEFPARAMETERS

The default initializing parameters.

See Also:

Constant Field Values

printCtrl

private boolean printCtrl

e

private MotorControllerException e

overwriteProgram

private boolean overwriteProgram

Constructor Detail

OmcMotor

public OmcMotor(Map<String,String> config)

Construct a new filter wheel similar to a motor controller, but defaulting its name to DEFDRIVERNAME.

Method Detail

printISOControl

public void printISOControl(boolean answer)

Whether or not the ISO control characters should be returned by sendCommand ().

Parameters:

ans - boolean (true or false)

isISOControl

public boolean isISOControl()

getParametersFor

protected Map<String,String> getParametersFor(String ax)

We have only a single axis, thus, always return a single map.

Specified by:

getParametersFor in class MotorController

getControllerParameter

protected double getControllerParameter(String param)
                                 throws IOException,
                                        NullPointerException

Throws:

IOException

NullPointerException

getControllerParameterArray

protected double[] getControllerParameterArray(int[] ipar)
                                        throws IOException,
                                               NullPointerException

Returns the values of all parameters indicated in the list.

Throws:

IOException

NullPointerException

getStepResolution

protected int getStepResolution()
                         throws IOException,
                                NullPointerException

Throws:

IOException

NullPointerException

setControllerParameter

protected void setControllerParameter(String param,
                                      int value)
                               throws IOException,
                                      NullPointerException

Throws:

IOException

NullPointerException

downloadPrg

public void downloadPrg(String prgName,
                        String fileName)
                 throws IllegalArgumentException,
                        IOException

Downloads a program from the controller and saves in a file.

Parameters:

prgName - The name of the program to be downloaded.

fileName - The name of the file to save the program in. The file will be overwritten if existed.

Throws:

IOException

IllegalArgumentException

downloadPrg

public String downloadPrg(String prgName)
                   throws IllegalArgumentException,
                          IOException

Downloads a program from the controller.

Parameters:

prgName - The name of the program to be downloaded.

Returns:

The program.

Throws:

IllegalArgumentException

IOException

cancelDownloadPrg

public String cancelDownloadPrg()
                         throws IOException

Cancels downloading the program. It returns the controllers response which should be nothing if the cancellation was successful.

Throws:

IOException

checkString

private String checkString(String str,
                           int requiredLength)
                    throws IllegalArgumentException

Check the length of a string and complete it with spaces to the required length if it is shorter, or throws IllegalArgumentException if the string is longer.

Parameters:

str - the string to be checked

requiredLength - the required lenght of the string

Throws:

IllegalArgumentException

setProgramOverwriteable

public void setProgramOverwriteable(boolean answ)

Sets whether or not the program is to be uploaded should overwrite the one in the controller if that already exists there.

Parameters:

answ - true or false

isProgramOverwriteable

public boolean isProgramOverwriteable()

Determines if the uploaded program should overwrite the existing one.

uploadPrg

public void uploadPrg(String prgName,
                      String fileName,
                      int autoStart)
               throws IOException,
                      MotorControllerException

Uploads a program stored in a file to the controller.

Parameters:

prgName - The name of the program in the controller.

fileName - The name of the file the program is stored in.

autoStart - If the program should be (1) or not (0) written in the controller's Auto Start register.

Throws:

IOException - In case of failing to open the program file.

MotorControllerException - If the program upload fails by some reasons.

reset

public void reset()
           throws IOException

Resets the controller.

Overrides:

reset in class MotorController

Throws:

IOException