|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--vfstagecontroller.StageController
Title: Stage controller class
Description: By the use of this class the programmer shold be able to control a microscope stage (x,y,z).
Copyright: Copyright (c) 2003
Company: Policlinico universitario di Udine
Field Summary | |
(package private) java.awt.Dialog |
dlgToHide
|
static int |
N_BOOKMARK
Max number of Bookmarks |
(package private) static java.util.Enumeration |
portList
|
(package private) static char |
X_COOR
To get x axis position |
(package private) static char |
Y_COOR
To get y axis position |
(package private) static char |
Z_COOR
To get z axis position |
Constructor Summary | |
StageController()
Construct a stage controller setting default connection parameters and no command area: "", 9600 baud,Flow control: NONE, 8 data bits, parity:NONE, 1 Stop bits |
|
StageController(SerialParameters connPar)
Construct a stage controller. |
|
StageController(SerialParameters connPar,
java.awt.TextArea area)
Construct a stage controller. |
|
StageController(java.awt.TextArea area)
Construct a stage controller setting default connection parameters: "", 9600 baud,Flow control: NONE, 8 data bits, parity:NONE, 1 Stop bits |
Method Summary | |
(package private) static void |
|
int |
addBookmark(java.lang.String name,
long x,
long y,
long z)
Add a position bookmark on bookmark array. |
void |
closeConnection()
Close the connection with the stage controller. |
java.lang.String |
enableStageBackLash(boolean b)
Enable or disable X,Y stage axis backlash |
java.lang.String |
enableZBackLash(boolean b)
Enable or disable Z stage axis backlash |
boolean |
getBacklashFocusStat()
Get Backlash focus status. |
boolean |
getBacklashStageStat()
Get Backlash stage X-Y status. |
long |
getBookmarkCoord(java.lang.String name,
char kind)
Return bookmark coordinate selected by kind param |
java.lang.String |
getBookmarkName(int i)
Retrive the bookmark name of position i |
java.lang.String[] |
getCommPortFounded()
Get com port currently on board |
SerialParameters |
getConnectionParameters()
Get current serial connection parameters to estabilish serial connection with openConnection command |
long |
getCurrentPos(char kind)
Get current position of requested axis: |
java.lang.String |
getDefaultPortName()
Gets default port for connection i.e. the port where connection will be attempted. |
int |
getMode()
Send a request to stage controller questioning about its mode: usually COMPATIBILITY or STANDARD. |
int |
getStatus()
Get status of the stage. |
long |
getXStepSize()
Gets current X Step size. |
int |
getXYAcc()
Return Stage XY acceleration. |
int |
getXYSpeed()
Get stage speed range. |
long |
getYStepSize()
Gets current Y Step size. |
int |
getZAcc()
Return Z axis acceleration. |
int |
getZSpeed()
Get z axis speed range. |
long |
getZStepSize()
Gets Z Step size in decimal micron. |
void |
initBookmarks()
Init bookmark array |
java.lang.String |
moveStageTo(long x,
long y)
Move stage to absolute position x,y |
void |
moveStageTo(long x,
long y,
long z)
Move Stage to Absolute position x,y,z |
java.lang.String |
moveXYStep(java.lang.String command)
Move stage in the selected direction by the size defined in the step dim: |
void |
moveZAxisTo(long z)
Move Z to Absolute position z |
java.lang.String |
moveZStep(java.lang.String command)
Move Z axis by one step: |
boolean |
openConnection()
Estabilish connection with the controller and ping the controller to check its functionality |
void |
run()
Launch searchSetLimits method. serchSetLimits() have to run in async mode to give to the user the possibility of process stopping. |
java.lang.String |
setAbsPos(int x,
int y,
int z)
Set current stage position to absolute position x,y,z. |
void |
setConnectionParameters(SerialParameters sp)
Set current serial connection parameters to estabilish serial connection with openConnection command |
void |
setDefaultPortName(java.lang.String dfpn)
Sets default port for connection i.e. the port where connection will be attempted. |
void |
setDialogToHide(java.awt.Dialog d)
Set the dialog to hide at the end of seachLimits methods |
java.lang.String |
setMode(int m)
Send to the stage the request to swap in mode m |
void |
setStageSpeed(int speed)
Deprecated. No enougth information on stage protocol manual |
void |
setXStepSize(long v)
Sets X-Step size of stage in micron. |
java.lang.String |
setXYAcc(int acc)
Set stage X,Y-axis acceleration. |
java.lang.String |
setXYSpeed(int speed)
Set stage XY-axis speed range. set X-Y Stage speed range |
java.lang.String |
setXYStepSize(long u,
long v)
Set X and Y Step size of stage in micron. |
java.lang.String |
setXYZStepSize(long u,
long v,
long w)
Set X, Y, Z Step size of stage in micron. |
void |
setYStepSize(long v)
Set Y-Step size of stage in micron. |
java.lang.String |
setZAcc(int acc)
Set stage Z-axis acceleration. |
java.lang.String |
setZSpeed(int speed)
Set stage Z-axis speed range. set Z Stage speed range |
java.lang.String |
setZStepSize(long v)
Set Z-Step size of stage in micron. |
java.lang.String |
stopStage()
Stop the stage if is moving. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
static char X_COOR
static char Y_COOR
static char Z_COOR
public static int N_BOOKMARK
static java.util.Enumeration portList
java.awt.Dialog dlgToHide
Constructor Detail |
public StageController()
public StageController(java.awt.TextArea area)
area
- echo commands TextAreapublic StageController(SerialParameters connPar)
connPar
- connection parameters for serial connection with the stage controllerpublic StageController(SerialParameters connPar, java.awt.TextArea area)
connPar
- connection parameters for serial connection with the stage controllerarea
- echo commands TextAreaMethod Detail |
static void()
public java.lang.String getDefaultPortName()
openConnection()
public void setDefaultPortName(java.lang.String dfpn)
dfpn
- SERIAL PORT NAME to be settedopenConnection()
public boolean openConnection() throws SerialConnectionException
SerialConnectionException
- moveStageTo(long, long, long)
,
closeConnection()
public void closeConnection()
openConnection()
public java.lang.String[] getCommPortFounded()
public SerialParameters getConnectionParameters()
openConnection()
,
setConnectionParameters(vfstagecontroller.SerialParameters)
public void setConnectionParameters(SerialParameters sp)
sp
- serial parametersopenConnection()
,
getConnectionParameters()
public void initBookmarks()
public int addBookmark(java.lang.String name, long x, long y, long z)
name
- Bookrmark namex
- coordinate of the bookmarky
- coordinatez
- coordinategetBookmarkName
,
getBookmarkCood
public java.lang.String getBookmarkName(int i)
i
- bookmark position inside bookmark arraypublic long getBookmarkCoord(java.lang.String name, char kind)
name
- Bookmark namekind
- x or y or z coordinate respecvely using X_COOR, Y_COOR, Z_COOR constantpublic long getCurrentPos(char kind)
kind
- X_COOR return x position, Y_COOR return y position, Z_COOR return z positionpublic long getXStepSize()
public long getYStepSize()
public long getZStepSize()
public void setXStepSize(long v)
v
- step size in micronpublic void setYStepSize(long v)
v
- step size in micronpublic java.lang.String setXYStepSize(long u, long v)
u
- X-Step size in micronv
- Y-Step size in micronpublic java.lang.String setZStepSize(long v)
v
- focus step size in micronpublic java.lang.String setXYZStepSize(long u, long v, long w)
u
- X-Step size in micronv
- Y-Step size in micronw
- Z-Step size in micronpublic boolean getBacklashStageStat()
public boolean getBacklashFocusStat()
public java.lang.String enableStageBackLash(boolean b)
b
- true=enable, false=disablepublic java.lang.String enableZBackLash(boolean b)
b
- true=enable, false=disablepublic void moveStageTo(long x, long y, long z)
x
- absolute X position in microny
- absolute Y position in micronz
- absolute Z position in micronpublic void moveZAxisTo(long z)
z
- absolute Z position in micronpublic java.lang.String moveStageTo(long x, long y)
x
- absolute X position in microny
- absolute Y position in micronpublic java.lang.String moveXYStep(java.lang.String command)
command
- movement direction:
StageCommands.MOVE_DOWN: move the stage a step down
StageCommands.MOVE_UP: move the stage a step up
StageCommands.MOVE_RIGHT:move the stage a step right
StageCommands.MOVE_LEFT: move the stage a step leftpublic java.lang.String moveZStep(java.lang.String command)
command
- movement direction:
StageCommands.MOVE_Z_UP move z up by one step
StageCommands.MOVE_Z_DOWN move z down by one steppublic java.lang.String setAbsPos(int x, int y, int z)
x
- new absolute X position (in micron) value for current X-Stage positiony
- new absolute Y position (in micron) value for current Y-Stage positionz
- new absolute Z position (in micron) value for current Z-Stage positionpublic void run()
run
in interface java.lang.Runnable
public void setStageSpeed(int speed)
speed
- speedpublic int getXYSpeed()
public java.lang.String setXYSpeed(int speed)
speed
- speedpublic int getXYAcc()
public java.lang.String setXYAcc(int acc)
acc
- X-Y accelerationpublic int getZSpeed()
public java.lang.String setZSpeed(int speed)
speed
- new speedpublic int getZAcc()
public java.lang.String setZAcc(int acc)
acc
- new Z accelerationpublic java.lang.String stopStage()
public int getMode()
public java.lang.String setMode(int m)
m
- modepublic int getStatus()
public void setDialogToHide(java.awt.Dialog d)
d
- the dialogsearchSetLimits
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |