|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--vfstagecontroller.StageCommands
Title: StageCommands Class
Description: This class (HAVE TO) contains all string (ASCII) codify of stage commands, and building methods necessary to generate consistent (well formed) stage commands for a serial stage controlled. Commands have to be sended to stage controller to control it. A tipical serial command has the following syntax: command[#par1][$par2]T where $ is a parameters separeator, # is command separator and T is a command terminator Typically $ = # = " " and T=Return (i.e. "\n") builtCommand functions permit to construct automatically a well formed command. The class here implemented is built to control the PRIOR OPTI SCAN STAGES! It is able to control X,Y,Z axis ONLY! Nothing deny the possibility to extend the class to control shutters or filters, but this imply to modify the StageController class. Changing this class maight allow the user to control other serial controller. In this case you have to pay attention on separator and special characters specification i.e. ,#,T loadCommandFromFile (will) allow user to load a different stage protocol from file.
Copyright: Copyright (c) 2003
Company: Policlinio Universitario di Udine
StageController
Field Summary | |
(package private) static java.lang.String |
CMD_SEPARATOR
Default command separator |
(package private) static char |
CMD_TERMINATOR
Command (character) terminator:Ex 13=Carriage return |
(package private) static java.lang.String |
FOCUS_BACKLASH_J
Stage Z joystick backlash command control |
(package private) static java.lang.String |
GET_COORD
Gets x,y,z stage coords |
(package private) static java.lang.String |
GET_STATUS
|
(package private) static int |
MAX_XY_ACC
X-Y acceleration range MAX |
(package private) static int |
MAX_XY_SPEED
X-Y speed range MAX |
(package private) static int |
MAX_Z_ACC
Z acceleration range MAX |
(package private) static int |
MAX_Z_SPEED
Z speed range MAX |
(package private) static int |
MIN_XY_ACC
X-Y acceleration range MIN |
(package private) static int |
MIN_XY_SPEED
X-Y speed range MIN |
(package private) static int |
MIN_Z_ACC
Z acceòeration range MIN |
(package private) static int |
MIN_Z_SPEED
Z speed range MIN |
(package private) static java.lang.String |
MODE
Command mode selector |
(package private) static java.lang.String |
MOVE_BWD
Move stage backward (by y steps) |
(package private) static java.lang.String |
MOVE_FWD
Move stage forward (by y steps) |
(package private) static java.lang.String |
MOVE_LEFT
Move stage left (by y steps) |
(package private) static java.lang.String |
MOVE_RIGHT
Move stage right (by y steps) |
(package private) static java.lang.String |
MOVE_TO_ABS_POS
Goes to absolute position x,y[,z] |
(package private) static java.lang.String |
MOVE_Z_DOWN
Move stage down (by y steps) |
(package private) static java.lang.String |
MOVE_Z_TO_ABS_POS
Moves Z to absolute position z |
(package private) static java.lang.String |
MOVE_Z_UP
Move stage up (by y steps) |
(package private) static java.lang.String |
PAR_SEPARATOR
Default parameters separator |
(package private) static java.lang.String |
SET_ABS_POS
Sets up absolute stage position |
(package private) static java.lang.String |
STAGE_BACKLASH_H
Stage X-Y backlash command control |
(package private) static java.lang.String |
STAGE_BACKLASH_J
Stage X-Y joystick backlash command control |
(package private) static int |
STAGE_MAX_SPEED
Stage min settable speed |
(package private) static int |
STAGE_MIN_SPEED
Stage max settable speed |
(package private) static java.lang.String |
STAGE_NAME
Stage controller drived by this class |
(package private) static java.lang.String |
STAGE_SPEED
Stage speed changer |
(package private) static java.lang.String |
STOP_STAGE
Stop stage command |
(package private) static long |
X_LIMIT
Stage X dimension |
(package private) static java.lang.String |
X_STEP_SIZE
Sets/gets X step size |
(package private) static java.lang.String |
XY_ACC
X-Y Acceleration control command |
(package private) static java.lang.String |
XY_JOY_SPEED
X-Y Speed under joistick control command |
(package private) static java.lang.String |
XY_SPEED
X-Y Speed control command |
(package private) static java.lang.String |
XYUnits
X and Y axis units |
(package private) static long |
Y_LIMIT
Stage Y dimension |
(package private) static java.lang.String |
Y_STEP_SIZE
Sets/gets Y step size |
(package private) static java.lang.String |
Z_ACC
Z Acceleration control command |
(package private) static java.lang.String |
Z_BACKLASH_H
Stage Z backlash command control |
(package private) static java.lang.String |
Z_JOY_SPEED
Z Speed under joistick control command |
(package private) static java.lang.String |
Z_SPEED
Z Speed control command |
(package private) static java.lang.String |
Z_STEP_SIZE
Sets/gets Z step size |
(package private) static java.lang.String |
ZUnits
Z axis units |
Constructor Summary | |
StageCommands()
|
Method Summary | |
static java.lang.String |
builtCommand(java.lang.String cmd)
Build a no-parameters instruction. |
static java.lang.String |
builtCommand(java.lang.String cmd,
long p1)
Build a single parameters instruction. |
static java.lang.String |
builtCommand(java.lang.String cmd,
long p1,
long p2)
Build a double parameters instruction. |
static java.lang.String |
builtCommand(java.lang.String cmd,
long p1,
long p2,
long p3)
Build a triple parameters instruction. |
static boolean |
loadCommandFromFile(java.lang.String file)
Deprecated. To be implemented! |
Methods inherited from class java.lang.Object |
|
Field Detail |
static java.lang.String STAGE_NAME
static final java.lang.String XYUnits
static final java.lang.String ZUnits
static final java.lang.String GET_STATUS
static final java.lang.String MODE
static final java.lang.String PAR_SEPARATOR
static final java.lang.String CMD_SEPARATOR
static final java.lang.String STOP_STAGE
static final java.lang.String MOVE_TO_ABS_POS
static final java.lang.String GET_COORD
static final java.lang.String MOVE_Z_TO_ABS_POS
static final char CMD_TERMINATOR
static final java.lang.String SET_ABS_POS
static final java.lang.String STAGE_BACKLASH_J
static final java.lang.String FOCUS_BACKLASH_J
static final java.lang.String STAGE_BACKLASH_H
static final java.lang.String Z_BACKLASH_H
static final java.lang.String XY_SPEED
static final java.lang.String XY_JOY_SPEED
static final java.lang.String XY_ACC
static final java.lang.String Z_SPEED
static final java.lang.String Z_JOY_SPEED
static final java.lang.String Z_ACC
static final java.lang.String X_STEP_SIZE
static final java.lang.String Y_STEP_SIZE
static final java.lang.String Z_STEP_SIZE
static final java.lang.String MOVE_FWD
static final java.lang.String MOVE_BWD
static final java.lang.String MOVE_LEFT
static final java.lang.String MOVE_RIGHT
static final java.lang.String MOVE_Z_UP
static final java.lang.String MOVE_Z_DOWN
static final long X_LIMIT
static final long Y_LIMIT
static final int MAX_XY_ACC
static final int MIN_XY_ACC
static final int MAX_Z_ACC
static final int MIN_Z_ACC
static final int MAX_XY_SPEED
static final int MIN_XY_SPEED
static final int MAX_Z_SPEED
static final int MIN_Z_SPEED
static final java.lang.String STAGE_SPEED
static final int STAGE_MIN_SPEED
static final int STAGE_MAX_SPEED
Constructor Detail |
public StageCommands()
Method Detail |
public static java.lang.String builtCommand(java.lang.String cmd)
cmd
- commandpublic static java.lang.String builtCommand(java.lang.String cmd, long p1)
cmd
- commandp1
- first argumentpublic static java.lang.String builtCommand(java.lang.String cmd, long p1, long p2)
cmd
- commandp1
- first argumentp2
- second argumentpublic static java.lang.String builtCommand(java.lang.String cmd, long p1, long p2, long p3)
cmd
- commandp1
- first argumentp2
- second argumentp3
- third argumentpublic static boolean loadCommandFromFile(java.lang.String file)
file
- file name where data is contained. File contains one commands for each line and each line has the following format:
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |