---

probeDbAccess.h File Reference

Go to the source code of this file.

Defines
#define	probeDB_ROOT   ":probe"
#define	probeDB_READ_ATTR(classIndex, attrIndex, buffer, error)
#define	probeDB_WRITE_ATTR(classIndex, attrIndex, buffer, error)
Enumerations
enum	probeDB_ACCESS_CLASS_INDEX {   probeDB_CI_REF_COORD, probeDB_CI_ACT_COORD, probeDB_CI_SENDREFS, probeDB_CI_STATUS,   probeDB_CI_LAST }
enum	probeDB_REF_COORD_INDEX {   probeDB_RC_ALPHA, probeDB_RC_DELTA, probeDB_RC_ALPHA_HMS, probeDB_RC_DELTA_DMS,   probeDB_RC_ALPHA_OBSERVED, probeDB_RC_DELTA_OBSERVED, probeDB_RC_DELTA_ALPHA, probeDB_RC_DELTA_DELTA,   probeDB_RC_OFFSET_ALPHA, probeDB_RC_OFFSET_DELTA, probeDB_RC_R, probeDB_RC_THETA,   probeDB_RC_AV_ALPHA, probeDB_RC_AV_DELTA, probeDB_RC_OFFSETU, probeDB_RC_OFFSETV,   probeDB_RC_OFFSETW, probeDB_RC_LAST }
enum	probeDB_ACT_COORD_INDEX {   probeDB_AC_ALPHA, probeDB_AC_DELTA, probeDB_AC_ALPHA_HMS, probeDB_AC_DELTA_DMS,   probeDB_AC_ALPHA_OBSERVED, probeDB_AC_DELTA_OBSERVED, probeDB_AC_ALPHA_MEAN_DEG, probeDB_AC_DELTA_MEAN_DEG,   probeDB_AC_DELTA_ALPHA, probeDB_AC_DELTA_DELTA, probeDB_AC_OFFSET_ALPHA, probeDB_AC_OFFSET_DELTA,   probeDB_AC_R, probeDB_AC_THETA, probeDB_AC_OFFSETU, probeDB_AC_OFFSETV,   probeDB_AC_OFFSETW, probeDB_AC_CCDANGLE, probeDB_AC_LAST }
enum	probeDB_SENDREFS_INDEX { probeDB_SR_ACTION, probeDB_SR_LAST }
enum	probeDB_STATUS_INDEX {   probeDB_ST_GP_OUT_OF_FIELD, probeDB_ST_GP_IN_POS, probeDB_ST_PROBE_TRK_LIMIT, probeDB_ST_PROBE_REM_TRK_TIME,   probeDB_ST_GS_SELECTED, probeDB_ST_SS_SELECTED, probeDB_ST_DIFF_TRACKING, probeDB_ST_LAST }
Functions
ccsCOMPL_STAT	probeDbAccessConstructor (const char *dbRoot, ccsERROR *error)
void	probeDbAccessDestructor (void)
char *	probeDbAccessGetAttrTable (const vltINT32 classIndex)
const char *	probeDbAccessGetAttrName (const vltINT32 classIndex, const vltINT32 index)

---

Define Documentation

#define probeDB_ROOT   ":probe"

Default database root of probe.

#define probeDB_READ_ATTR (  classIndex, attrIndex, buffer, error    )

Value: if (caiRWAttribute(probeDbAccessGetAttrTable(classIndex),ccsFALSE,attrIndex,buffer, \ error) == FAILURE) \ { \ probeERR_ADD(probeERR_DBREAD,error,probeDbAccessGetAttrName(classIndex,attrIndex)); \ return FAILURE; \ } Read data from the public database branch. Parameters: classIndex  the index of the referred class (probeDB_ACCESS_CLASS_INDEX) attrIndex  the index of the attribute within the class (e.g. probeDB_REF_COORD_INDEX) buffer  the return buffer error  the error structure Returns: FAILURE when read failed (error is added to the stack), otherwise continue execution

#define probeDB_WRITE_ATTR (  classIndex, attrIndex, buffer, error    )

Value: if (caiRWAttribute(probeDbAccessGetAttrTable(classIndex),ccsTRUE,attrIndex,buffer, \ error) == FAILURE) \ { \ probeERR_ADD(probeERR_DBWRITE, error, probeDbAccessGetAttrName(classIndex,attrIndex)); \ return FAILURE; \ } Write data to the public database branch. Parameters: classIndex  the index of the referred class (probeDB_ACCESS_CLASS_INDEX) attrIndex  the index of the attribute within the class (e.g. probeDB_REF_COORD_INDEX) buffer  the return buffer error  the error structure Returns: FAILURE when write failed (error is added to the stack), otherwise continue execution

---

Enumeration Type Documentation

enum probeDB_ACCESS_CLASS_INDEX

Enumeration values: probeDB_CI_REF_COORD  probeDB_CI_ACT_COORD  probeDB_CI_SENDREFS  probeDB_CI_STATUS  probeDB_CI_LAST

enum probeDB_REF_COORD_INDEX

Enumeration values: probeDB_RC_ALPHA  probeDB_RC_DELTA  probeDB_RC_ALPHA_HMS  probeDB_RC_DELTA_DMS  probeDB_RC_ALPHA_OBSERVED  probeDB_RC_DELTA_OBSERVED  probeDB_RC_DELTA_ALPHA  probeDB_RC_DELTA_DELTA  probeDB_RC_OFFSET_ALPHA  probeDB_RC_OFFSET_DELTA  probeDB_RC_R  probeDB_RC_THETA  probeDB_RC_AV_ALPHA  probeDB_RC_AV_DELTA  probeDB_RC_OFFSETU  probeDB_RC_OFFSETV  probeDB_RC_OFFSETW  probeDB_RC_LAST

enum probeDB_ACT_COORD_INDEX

Enumeration values: probeDB_AC_ALPHA  probeDB_AC_DELTA  probeDB_AC_ALPHA_HMS  probeDB_AC_DELTA_DMS  probeDB_AC_ALPHA_OBSERVED  probeDB_AC_DELTA_OBSERVED  probeDB_AC_ALPHA_MEAN_DEG  probeDB_AC_DELTA_MEAN_DEG  probeDB_AC_DELTA_ALPHA  probeDB_AC_DELTA_DELTA  probeDB_AC_OFFSET_ALPHA  probeDB_AC_OFFSET_DELTA  probeDB_AC_R  probeDB_AC_THETA  probeDB_AC_OFFSETU  probeDB_AC_OFFSETV  probeDB_AC_OFFSETW  probeDB_AC_CCDANGLE  probeDB_AC_LAST

enum probeDB_SENDREFS_INDEX

Enumeration values: probeDB_SR_ACTION  probeDB_SR_LAST

enum probeDB_STATUS_INDEX

Enumeration values: probeDB_ST_GP_OUT_OF_FIELD  probeDB_ST_GP_IN_POS  probeDB_ST_PROBE_TRK_LIMIT  probeDB_ST_PROBE_REM_TRK_TIME  probeDB_ST_GS_SELECTED  probeDB_ST_SS_SELECTED  probeDB_ST_DIFF_TRACKING  probeDB_ST_LAST

---

Function Documentation

ccsCOMPL_STAT probeDbAccessConstructor (  const char *    dbRoot, ccsERROR *    error )

Setup internal data structures for accessing the database (cai).

void probeDbAccessDestructor (  void    )

Release all internal structures. After this function no database access is possible.

char* probeDbAccessGetAttrTable (  const vltINT32    classIndex )

const char* probeDbAccessGetAttrName (  const vltINT32    classIndex, const vltINT32    index )

---