Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

atm2Mirror.h File Reference

Go to the source code of this file.

Functions

ccsCOMPL_STAT atm2MirrorInit (OUT ccsERROR *error)
ccsCOMPL_STAT atm2MirrorStandby (OUT ccsERROR *error)
ccsCOMPL_STAT atm2MirrorOnline (OUT ccsERROR *error)
ccsCOMPL_STAT atm2MirrorStop (OUT ccsERROR *error)
ccsCOMPL_STAT atm2MirrorOff (OUT ccsERROR *error)
ccsCOMPL_STAT atm2MirrorGetStatus (OUT vltINT32 *m2Status, OUT ccsERROR *error)
const char * atm2MirrorGetStatusName (IN vltINT32 m2Status)
ccsCOMPL_STAT atm2MirrorSetCenterPosition (IN vltDOUBLE x, IN vltDOUBLE y, OUT ccsERROR *error)
ccsCOMPL_STAT atm2MirrorGetCenterPosition (IN vltDOUBLE *x, IN vltDOUBLE *y, OUT ccsERROR *error)
ccsCOMPL_STAT atm2MirrorSetFocusPosition (IN vltDOUBLE z, OUT ccsERROR *error)
ccsCOMPL_STAT atm2MirrorGetFocusPosition (IN vltDOUBLE *z, OUT ccsERROR *error)
ccsCOMPL_STAT atm2MirrorSetTiltAngles (IN vltDOUBLE a, IN vltDOUBLE b, OUT ccsERROR *error)
ccsCOMPL_STAT atm2MirrorGetTiltAngles (IN vltDOUBLE *a, IN vltDOUBLE *b, OUT ccsERROR *error)

Function Documentation

ccsCOMPL_STAT atm2MirrorInit (  OUT ccsERROR *    error ) 
 

ccsCOMPL_STAT atm2MirrorStandby (  OUT ccsERROR *    error ) 
 

ccsCOMPL_STAT atm2MirrorOnline (  OUT ccsERROR *    error ) 
 

ccsCOMPL_STAT atm2MirrorStop (  OUT ccsERROR *    error ) 
 

ccsCOMPL_STAT atm2MirrorOff (  OUT ccsERROR *    error ) 
 

ccsCOMPL_STAT atm2MirrorGetStatus (  OUT vltINT32 *    m2Status,
OUT ccsERROR *    error
) 
 

const char* atm2MirrorGetStatusName (  IN vltINT32    m2Status ) 
 

ccsCOMPL_STAT atm2MirrorSetCenterPosition (  IN vltDOUBLE    x,
IN vltDOUBLE    y,
OUT ccsERROR *    error
) 
 

ccsCOMPL_STAT atm2MirrorGetCenterPosition (  IN vltDOUBLE *    x,
IN vltDOUBLE *    y,
OUT ccsERROR *    error
) 
 

Get M2's center position.

returns current position of X,Y M2 axes.

Note: Mirror buffer is flushed before sending the command, don't know if this is really needed -- or useful -- since we have no Hw yet.

Parameters:
x  where to store X axis position
y  where to store Y axis position
error  error structure
Returns:
SUCCESS or FAILURE

ccsCOMPL_STAT atm2MirrorSetFocusPosition (  IN vltDOUBLE    z,
OUT ccsERROR *    error
) 
 

Set M2 Focus position (moves Z axis). Writes to DB <alias>atm2:control:mirror:M2 the attributes:

z
target center pos for Z axis (mm)

Read from DB <alias>atm2:control:mirror:M2 the attributes:

mirrorTimeout
Timeout to wait reply from M2 controller (secs)

Note: Mirror buffer is flushed before sending the command, don't know if this is really needed -- or useful -- since we have no Hw yet.

Parameters:
z  Z axis target position (mm)
error  error structure
Returns:
SUCCESS or FAILURE

ccsCOMPL_STAT atm2MirrorGetFocusPosition (  IN vltDOUBLE *    z,
OUT ccsERROR *    error
) 
 

Get M2 Focus position.

returns current position of Z M2 axe.

Note: Mirror buffer is flushed before sending the command, don't know if this is really needed -- or useful -- since we have no Hw yet.

Parameters:
z  where to store Z axis position
error  error structure
Returns:
SUCCESS or FAILURE

ccsCOMPL_STAT atm2MirrorSetTiltAngles (  IN vltDOUBLE    a,
IN vltDOUBLE    b,
OUT ccsERROR *    error
) 
 

Sets M2 tilt angle Writes to DB <alias>atm2:control:mirror:M2 the attributes:

alpha
target center pos for alpha axis (radians)
beta
target center pos for beta axis (radians)

Read from DB <alias>atm2:control:mirror:M2 the attributes:

mirrorTimeout
Timeout to wait reply from M2 controller (secs)

Note: Mirror buffer is flushed before sending the command, don't know if this is really needed -- or useful -- since we have no Hw yet.

Parameters:
alpha  Alpha axis target position (rad)
beta  Beta axis target position (rad)
error  error structure
Returns:
SUCCES or FAILURE

ccsCOMPL_STAT atm2MirrorGetTiltAngles (  IN vltDOUBLE *    a,
IN vltDOUBLE *    b,
OUT ccsERROR *    error
) 
 

Get M2's center position.

returns current position M2 tilt anle (alpha, beta).

Note: Mirror buffer is flushed before sending the command, don't know if this is really needed -- or useful -- since we have no Hw yet.

Parameters:
a  where to store alpha axis position
b  where to store beta axis position
error  error structure
Returns:
SUCCES or FAILURE

Generated on Wed Dec 3 14:53:38 2003 for ATCS API by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001