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

probeServer.h File Reference

Go to the source code of this file.

probe server API functions

ccsCOMPL_STAT probeOffsetGUV (const vltDOUBLE deltaU, const vltDOUBLE deltaV, const vltDOUBLE deltaW, const vltLOGICAL fromRef, OUT ccsERROR *error)
ccsCOMPL_STAT probeSetOffsetXY (const vltDOUBLE deltaX, const vltDOUBLE deltaY, OUT ccsERROR *error)
ccsCOMPL_STAT probeServerSetProbeRD (vltDOUBLE alpha, vltDOUBLE delta, const vltLOGICAL checkVignettingPos, const vltDOUBLE lambda, ccsERROR *error)
ccsCOMPL_STAT probeServerCheckProbePos (const char *utc, const vltDOUBLE alphaObj, const vltDOUBLE deltaObj, const vltDOUBLE alphaGs, const vltDOUBLE deltaGs, const vltDOUBLE lamGs, const vltLOGICAL checkVignettingPos, ccsERROR *error)
ccsCOMPL_STAT probeServerCenterProbe (const vltDOUBLE telAzDeg, ccsERROR *error)
ccsCOMPL_STAT probeServerProbeToObj (ccsERROR *error)
ccsCOMPL_STAT probeServerOffsetProbeAD (const vltDOUBLE offsAlpha, const vltDOUBLE offsDelta, OUT ccsERROR *error)
ccsCOMPL_STAT probeServerParkProbe (const vltDOUBLE telAzDeg, OUT ccsERROR *error)
ccsCOMPL_STAT probeServerSetAdVel (const vltDOUBLE avAlpha, const vltDOUBLE avDelta, OUT ccsERROR *error)
ccsCOMPL_STAT probeServerEnableDiffTrk (OUT ccsERROR *error)
ccsCOMPL_STAT probeServerDisableDiffTrk (OUT ccsERROR *error)
ccsCOMPL_STAT probeServerCheckGpInPos (OUT ccsERROR *error)
ccsCOMPL_STAT probeServerSetWaveLength (const vltDOUBLE lambda, OUT ccsERROR *error)
ccsCOMPL_STAT probeServerUpdateConfig (OUT ccsERROR *error)
ccsCOMPL_STAT probeServerSetOffset (OUT ccsERROR *error)
ccsCOMPL_STAT probeServerGetProbeRemTrkTime (const char *utc, const vltDOUBLE alpha, const vltDOUBLE delta, const char epochSystem, const vltDOUBLE epoch, const vltDOUBLE equinox, const vltDOUBLE pma, const vltDOUBLE pmd, const vltDOUBLE radvel, const vltDOUBLE parallax, const char coordType, vltDOUBLE *remTrkTime, ccsERROR *error)
void probeServerStatus (char *msg)

Function Documentation

ccsCOMPL_STAT probeOffsetGUV (  const vltDOUBLE    deltaU,
const vltDOUBLE    deltaV,
const vltDOUBLE    deltaW,
const vltLOGICAL    fromRef,
OUT ccsERROR *    error
) 
 

Offset guide probe in UVW coordinates

Parameters:
deltaU  delta U
deltaV  delta V
deltaW  delta W
fromref  apply offset from current position
error  error structure

ccsCOMPL_STAT probeSetOffsetXY (  const vltDOUBLE    deltaX,
const vltDOUBLE    deltaY,
OUT ccsERROR *    error
) 
 

Offset guide probe in X/Y

Parameters:
deltaX  delta X
deltaY  delta Y
error  error structure

ccsCOMPL_STAT probeServerSetProbeRD (  vltDOUBLE    alpha,
vltDOUBLE    delta,
const vltLOGICAL    checkVignettingPos,
const vltDOUBLE    lambda,
ccsERROR *    error
) 
 

Set guide probe to Ra/Decl coordinates.

Parameters:
alpha  RA guidestar in HMS
delta  DEC guidstar in DMS
checkVignettingPos  specifies whether a vignetting end-position of the probe is allowed (false) or not (true). Default is to allow vignetting.
lambda  observed wavelength of guide star (nm)
error  error structure

ccsCOMPL_STAT probeServerCheckProbePos (  const char *    utc,
const vltDOUBLE    alphaObj,
const vltDOUBLE    deltaObj,
const vltDOUBLE    alphaGs,
const vltDOUBLE    deltaGs,
const vltDOUBLE    lamGs,
const vltLOGICAL    checkVignettingPos,
ccsERROR *    error
) 
 

Check if the guide star would result in a valid probe position for the current time and target object.

Parameters:
alphaObj  RA of the guide star in HMS
deltaObj  DEC of the guide star in DMS
alphaGs  RA of the guide star in HMS
deltaGs  DEC of the guide star in DMS
lamGs  wavelength of the guide star

ccsCOMPL_STAT probeServerCenterProbe (  const vltDOUBLE    telAzDeg,
ccsERROR *    error
) 
 

Center the probe.

ccsCOMPL_STAT probeServerProbeToObj (  ccsERROR *    error ) 
 

Move probe to observed object.

ccsCOMPL_STAT probeServerOffsetProbeAD (  const vltDOUBLE    offsAlpha,
const vltDOUBLE    offsDelta,
OUT ccsERROR *    error
) 
 

Offset the probe in alpha/delta.

Parameters:
offsAlpha  offset in alpha in arcseconds
offsDelta  offset in delta in arcseconds

ccsCOMPL_STAT probeServerParkProbe (  const vltDOUBLE    telAzDeg,
OUT ccsERROR *    error
) 
 

Park the probe

ccsCOMPL_STAT probeServerSetAdVel (  const vltDOUBLE    avAlpha,
const vltDOUBLE    avDelta,
OUT ccsERROR *    error
) 
 

Set additional velocities in alpha/delta.

Parameters:
avAlpha  additional velocity in alpha in arcsecs/sec
avDelta  additional velocity in delta in arcsecs/sec

ccsCOMPL_STAT probeServerEnableDiffTrk (  OUT ccsERROR *    error ) 
 

Enable differential tracking.

ccsCOMPL_STAT probeServerDisableDiffTrk (  OUT ccsERROR *    error ) 
 

Disable differential tracking.

ccsCOMPL_STAT probeServerCheckGpInPos (  OUT ccsERROR *    error ) 
 

Check if guide probe is in position.

ccsCOMPL_STAT probeServerSetWaveLength (  const vltDOUBLE    lambda,
OUT ccsERROR *    error
) 
 

Set observed wavelength of the guide star.

Parameters:
lambda  wavelength in nanometers

ccsCOMPL_STAT probeServerUpdateConfig (  OUT ccsERROR *    error ) 
 

Update configuration from database.

ccsCOMPL_STAT probeServerSetOffset (  OUT ccsERROR *    error ) 
 

Set offset for second tracking source.

ccsCOMPL_STAT probeServerGetProbeRemTrkTime (  const char *    utc,
const vltDOUBLE    alpha,
const vltDOUBLE    delta,
const char    epochSystem,
const vltDOUBLE    epoch,
const vltDOUBLE    equinox,
const vltDOUBLE    pma,
const vltDOUBLE    pmd,
const vltDOUBLE    radvel,
const vltDOUBLE    parallax,
const char    coordType,
vltDOUBLE *    remTrkTime,
ccsERROR *    error
) 
 

Get remaining tracking time.

Parameters:
utc  UTC in ISO-format. if 0 then current time is taken
alpha  alpha of the guide star. if 0 then actual alpha is taken
delta  delta of the guide star. if 0 then actual delta is taken
epochSystem  B,J (not used, J is assumed)
epoch  epoch (not used, 2000 is assumed)
equinox  equinox (not used, 2000 is assumed)
pma  proper motion alpha (not used)
pmd  proper motion delta @rdavel radial velocitiy
allax parallax
@coordType coordinate type M(ean), A(pparent) @remTrkTime remaining tracking time in seconds

void probeServerStatus (  char *    msg ) 
 

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