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

probePrtrk.h File Reference

#include "lsfTaskDev.h"

Include dependency graph for probePrtrk.h:

Include dependency graph

Go to the source code of this file.

Probe tracking task

#define probeTRK_TASK   "prtrk"
ccsCOMPL_STAT probePrtrkConstructor (ccsERROR *error)
ccsCOMPL_STAT probePrtrkDestructor (ccsERROR *error)
ccsCOMPL_STAT probePrtrkGetAv (vltDOUBLE *avAlpha, vltDOUBLE *avDelta, ccsERROR *error)
ccsCOMPL_STAT probePrtrkSetAv (const vltDOUBLE avAlpha, const vltDOUBLE avDelta, ccsERROR *error)
ccsCOMPL_STAT probePrtrkSetLam (const vltDOUBLE lambda, ccsERROR *error)
vltDOUBLE probePrtrkGetLam ()
ccsCOMPL_STAT probePrtrk (const lsfTASKDEV_DATA *taskDevData, const char *taskDevName, ccsERROR *error)
ccsCOMPL_STAT probePrtrkProHook (const lsfTASKDEV_DATA *taskDevData, const char *taskDevName, ccsERROR *error)
ccsCOMPL_STAT probePrtrkEpiHook (const lsfTASKDEV_DATA *taskDevData, const char *taskDevName, ccsERROR *error)
ccsCOMPL_STAT probePrtrkCalcReady (ccsERROR *error)
ccsCOMPL_STAT probePrtrkCalcValid (const vltUINT32 maxDelay, ccsTIMEVAL *time, ccsERROR *error)
vltINT32 probePrtrkGetBgCalcPeriod ()
ccsCOMPL_STAT probePrtrkCheckCoord (const vltDOUBLE alphaGs, const vltDOUBLE deltaGs, const vltLOGICAL checkVignettingPos, const vltDOUBLE lamGs, ccsERROR *error)
ccsCOMPL_STAT probePrtrkSetProbeAD (const vltDOUBLE alphaGs, const vltDOUBLE deltaGs, const vltDOUBLE lamGs, ccsERROR *error)
ccsCOMPL_STAT probePrtrkCheckTracking (vltLOGICAL *tracking, ccsERROR *error)
ccsCOMPL_STAT probePrtrkBgCoord (vltDOUBLE *mjd, ccsERROR *error)
ccsCOMPL_STAT probePrtrkSetDiffTrk (const vltLOGICAL enable, ccsERROR *error)
vltLOGICAL probePrtrkGetDiffTrk ()
void probePrtrkSetRecalcRef (const vltLOGICAL state)
vltLOGICAL probePrtrkGetRecalcRef ()
ccsCOMPL_STAT probePrtrkSetGsSelected (const vltLOGICAL state, ccsERROR *error)
vltLOGICAL probePrtrkGetGsSelected ()
ccsCOMPL_STAT probePrtrkProtectMove (ccsERROR *error)
void probePrtrkUnProtectMove ()
vltDOUBLE probePrtrkGetMoveThr ()

Define Documentation

#define probeTRK_TASK   "prtrk"
 

Function Documentation

ccsCOMPL_STAT probePrtrkConstructor (  ccsERROR *    error ) 
 

Constructor of probe tracking task. The constructor has to be called before any use of the class. It sets up the internal structures

ccsCOMPL_STAT probePrtrkDestructor (  ccsERROR *    error ) 
 

Destructor of probe tracking task. Th destructor is called at the end of all activities. No access after calling it is allowed.

ccsCOMPL_STAT probePrtrkGetAv (  vltDOUBLE *    avAlpha,
vltDOUBLE *    avDelta,
ccsERROR *    error
) 
 

Get current Additional velocity. The access is sempahore protected.

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

ccsCOMPL_STAT probePrtrkSetAv (  const vltDOUBLE    avAlpha,
const vltDOUBLE    avDelta,
ccsERROR *    error
) 
 

Set Additional velocity. The reference values are also updated in the database.

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

ccsCOMPL_STAT probePrtrkSetLam (  const vltDOUBLE    lambda,
ccsERROR *    error
) 
 

Set guide star observed wavelength. It's used for differential tracking and guidestar refraction calculations.

Parameters:
lambda  IN: wavelength in nm

vltDOUBLE probePrtrkGetLam (    ) 
 

Get the current guide star lambda.

Returns:
wavelength in microns (slalib conform)

ccsCOMPL_STAT probePrtrk (  const lsfTASKDEV_DATA *    taskDevData,
const char *    taskDevName,
ccsERROR *    error
) 
 

Main loop of probe tracking task

ccsCOMPL_STAT probePrtrkProHook (  const lsfTASKDEV_DATA *    taskDevData,
const char *    taskDevName,
ccsERROR *    error
) 
 

Prolog function hook for probe tracking task

ccsCOMPL_STAT probePrtrkEpiHook (  const lsfTASKDEV_DATA *    taskDevData,
const char *    taskDevName,
ccsERROR *    error
) 
 

Epilog function hook for probe tracking task

ccsCOMPL_STAT probePrtrkCalcReady (  ccsERROR *    error ) 
 

Wait until probe differential tracking calculations have been done ONCE. It does NOT mean that the calculations are still done.

Parameters:
error  structure
Returns:
FAILURE if calculations have not been done, SUCCESS if calculations have been done ONCE.
See also:
probePrtrkCalcValid

ccsCOMPL_STAT probePrtrkCalcValid (  const vltUINT32    maxDelay,
ccsTIMEVAL *    time,
ccsERROR *    error
) 
 

Check if the calculations have been updated within a defined time frame and that they are valid.

Parameters:
time  the current time, when the evaluation was done
maxDelay  the maximum delay in seconds for which the calculation is still considered valid
Returns:
SUCCESS if calculations are valid, FAILURE if they are not valid or it could not determined if they are ready.
See also:
probePrtrkCalcReady

vltINT32 probePrtrkGetBgCalcPeriod (    ) 
 

Get the period of the background calculations.

Returns:
period in seconds

ccsCOMPL_STAT probePrtrkCheckCoord (  const vltDOUBLE    alphaGs,
const vltDOUBLE    deltaGs,
const vltLOGICAL    checkVignettingPos,
const vltDOUBLE    lamGs,
ccsERROR *    error
) 
 

Check if the given alpha/delta coordinates of a guide star are valid.

Parameters:
alphaGs  RA of the guide star in mean J2000/2000 (radians).
deltaGs  DEC of the guide star in mean J2000/2000 (radians).
checkVignettingPos  specifies whether a vignetting end-position of the probe is allowed (false) or not (true). Default is to allow vignetting. Not supported.
lamGs  observed wavelength of the guide star (nm)

ccsCOMPL_STAT probePrtrkSetProbeAD (  const vltDOUBLE    alphaGs,
const vltDOUBLE    deltaGs,
const vltDOUBLE    lamGs,
ccsERROR *    error
) 
 

Set guide probe to alpha/delta.

Parameters:
alphaGs  RA guidestar radians
deltaGs  DEC guidestar radians
checkVignettingPos  specifies whether a vignetting end-position of the probe is allowed (false) or not (true). Default is to allow vignetting.
lamGs  observed wavelength of guide star (nm)

ccsCOMPL_STAT probePrtrkCheckTracking (  vltLOGICAL *    tracking,
ccsERROR *    error
) 
 

Check if the probe is tracking. The probe is tracking if: trkServer is in the substate tracking or preset and the last command from tracking was acmACTION_STAR

Parameters:
tracking  ccsTRUE if tracking
error  returned error structure

ccsCOMPL_STAT probePrtrkBgCoord (  vltDOUBLE *    mjd,
ccsERROR *    error
) 
 

Perform background calculation with given MJD.

ccsCOMPL_STAT probePrtrkSetDiffTrk (  const vltLOGICAL    enable,
ccsERROR *    error
) 
 

Control differential tracking.

Parameters:
enable  IN: ccsTRUE enables differential tracking, ccsFALSE disables it.

vltLOGICAL probePrtrkGetDiffTrk (    ) 
 

Get state of differential tracking.

Returns:
ccsTRUE if enabled, ccsFALSE if disabled

void probePrtrkSetRecalcRef (  const vltLOGICAL    state ) 
 

Control state of recalculate reference coordinates. If set then the reference coordinates are derived from the actual position. This is used in the case where no reference coordinates are available; e.g. when no preset with alpha/delta has been done.

vltLOGICAL probePrtrkGetRecalcRef (    ) 
 

Get state of recalculate reference coordinates

ccsCOMPL_STAT probePrtrkSetGsSelected (  const vltLOGICAL    state,
ccsERROR *    error
) 
 

Control state of guide star selected flag. The guide star selected flag is set, when the probe is preset to a new guide star. Only when this flag is set the probe is actually moved.

vltLOGICAL probePrtrkGetGsSelected (    ) 
 

Get state of guide star selected flag.

ccsCOMPL_STAT probePrtrkProtectMove (  ccsERROR *    error ) 
 

Protect movement of guide probe in case there are independent accesses.

void probePrtrkUnProtectMove (    ) 
 

Uprotect movement of guide probe.

vltDOUBLE probePrtrkGetMoveThr (    ) 
 

Retrieve Move Threshold.

Returns:
threshold in arcsecs

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