---

ag.h

Go to the documentation of this file.

/*******************************************************************************
* E.S.O. - VLT project
*
* "@(#) $Id: ag.h,v 1.98 2003/11/11 14:58:39 vltsccm Exp $" 
*
* ag.h
*
* who       when      what
* --------  --------  ----------------------------------------------
* rkarban 2002-02-11 make agDbReadTrkAxisList public
* rkarban 2002-02-11 add agSendOffsetMsgPublic
* rkarban 2002-02-11 make agPixSize public
* rkarban 2002-02-11 make agDbReadRotAngle public
* rkarban 2002-02-11 move GetAgId from agInternal.h
* gchiozzi  19/02/99  Removed possibility of writing to logFile (spr 990011)
* tcsmgr  18/10/98  Common defines are in agDefines.h
* tcsmgr  09/10/98  Added PII_PARMS structure
* gchiozzi  01/10/98  Created new agPII_HISTORY structure
* gchiozzi  30/09/98  PII controller is now frequency dependent.
* tcsmgr    17/09/98  Added database definitions for ccdip checking configuration.
* tcsmgr    10/05/98  Added setting of exposure time structure in agUfBuff
* tphan     10/03/96  First version
* tphan     13/11/96  Delete CCD db definition
*-----------------------------------------------------------------------------*/

#ifndef AG_H
#define AG_H

#include "ccdip.h"
#include "agDefines.h"
/*
 * Object ag - Public Definitions File
 */

/*
 * Constants
 */

#define agCMD_OFFSAG    "OFFSAG"
#define agCMD_GETAGID   "GETAGID"

#define agCMD_OFFSAG    "OFFSAG"

static const char *agErrorVectorValues[] = 
{
    "LAST",
    "MEAN",
};

/*
 * Types
 */
typedef struct
{
    vltDOUBLE      ipCenIntensity;
    ccdipAGBUF     ipBuff;
    ccdIPEXPOSURE  exposure;
} agCcdipAGBUF;

typedef enum      /* for error vector Values */
    {
    agLAST,
    agMEAN,
} agERROR_VECTOR_VALUES;
    
    
typedef struct
    {
    vltDOUBLE ipXCen;
    vltDOUBLE ipYCen;
    vltDOUBLE ipCenIntensity;
} agERROR_VECTOR;

typedef struct
    {
    vltDOUBLE alpha;
    vltDOUBLE delta;
} agOFFSET;

typedef struct
    {
    ccsENVNAME  envName;
    ccsPROCNAME procName;
} agTRK_AXIS;

typedef struct
    {
    vltINT32   nbrAxisDefined;
    agTRK_AXIS   axis[agMAX_DESTINATION];
    msgPROCESSID destId[agMAX_DESTINATION];
    ccsERROR     errMsg;      /* For Replies to alt/az */
} agTRK_AXIS_LIST;


/*
 *  PII controller configuration structures
 *  =======================================
 */

/*
 * PII Configuration as on the DB
 */
typedef struct
{
    vltDOUBLE Kp;
    vltDOUBLE Ki;
    vltDOUBLE Kii;
    vltDOUBLE MaxI;
    vltDOUBLE MaxII;
    vltINT32    freqDep;
} agPII;

/*
 * PII parameters that can be modified via SETPII command
 */
typedef struct
{
    vltDOUBLE Kp;
    vltDOUBLE Ki;
    vltDOUBLE Kii;
    vltDOUBLE MaxI;
    vltDOUBLE MaxII;
} agPII_CMD;

/*
 * PII history structure with I and II 
 *     values updated at any iteration
 *     and corresponding calculated correction
 */
typedef struct
{
    vltDOUBLE   correction;
    vltDOUBLE   I;
    vltDOUBLE   II;
} agPII_HISTORY;


/*
 * Data
 */

/*
 * Function
 */

ccsCOMPL_STAT agInitAll(char *ccdName, char *dbRoot);

ccsCOMPL_STAT agDbReadTrkAxisList (
  OUT agTRK_AXIS_LIST *axisList,
  OUT ccsERROR    *error);
 
ccsCOMPL_STAT agDbWriteTrkAxisList (
  IN  agTRK_AXIS_LIST *axisList,
  OUT ccsERROR    *error);
 
ccsCOMPL_STAT agNoticeErrorVector (
  OUT ccsERROR    *error
  );
/*
 * agStartAg.c
 */
ccsCOMPL_STAT agStartAg (
      IN  msgMSG  *msg,
  IN  vltDOUBLE rotAngle,
  IN  vltDOUBLE repFrq,
  IN  char  *at,
  OUT ccsERROR  *error);

ccsCOMPL_STAT agStopAg (OUT ccsERROR  *error);

ccsCOMPL_STAT agSendOffsetMsgPublic (
  IN  agOFFSET    *offset,
  OUT ccsERROR    *error
    );

ccsCOMPL_STAT agDbReadRotAngle (OUT vltDOUBLE *rotAngle,
        OUT ccsERROR    *error);

ccsCOMPL_STAT agPixSize (
  OUT vltDOUBLE *pixSize, 
  OUT ccsERROR  *error
    );

ccsCOMPL_STAT agDbReadTrkAxisList (
  OUT agTRK_AXIS_LIST *axisList,
  OUT ccsERROR    *error);

/*
 * agGetAgId.c
 */

ccsCOMPL_STAT agGetAgId (IN  agTRK_AXIS_LIST *trkAxisList,
       OUT ccsERROR        *error);

/*
 * agRms.c
 */
ccsCOMPL_STAT agRmsInit (OUT ccsERROR  *error);

/*
 * agFindSymbol.c
 */
ccsCOMPL_STAT agFindSymbol(
        IN  char        *symName,
        OUT FUNCPTR *sym,
        OUT ccsERROR    *error);

/*
 *  User functions
 */
ccsCOMPL_STAT agUfBase (
  IN  ccdIPIMAGE *img, 
  IN  void       *notUsed, 
  OUT ccsERROR   *err);

ccsCOMPL_STAT agUf1 (
  IN  ccdIPIMAGE *img, 
  IN  void       *notUsed, 
  OUT ccsERROR   *err);


#endif /* !AG_H */

---