/*
  Pidf.h
*/

#ident "@(#) $Id: pidf.h 22019 2012-12-05 19:28:41Z carrie $  SwRI"

#ifndef _PIDF_H
#define _PIDF_H

#include "SDDAS_types.h"

#define SCAN_DATA   99                /* for compatibility */

#ifndef _PIDF_ENUM_
#define _PIDF_ENUM_
typedef enum {
	VERSION,
	INSTITUTE,
	PROJ,
	MISS,
	EXP,
	INST,
	VINST,
	MASK,
	PIDFNUM,
	VIDFNUM,
	COMPNAMES,
	PIDFTYPE,
	SCFPATH,
	SENNAMES,
	BININDEX,
	SENSETS,
        TOTALUNITS,
	NUNITS,
	UNITNUM,
	UNITNUMS,
	COMPNAME,
	NAME,
	SHORTNAME,
	NAMES,
	NUMOF,
	NSETS,
	NUMINGRP,
	DIMEN,
	PLTAVL,
	START,
	STOP,
	SPACING,
	BINMETHOD,
	DISPLAY,
	DEFAULTMAX,
	DEFAULTMIN,
	SCALING,
	SHORTDESC,
	LONGDESC,
	UNITLAB,
	TABLEAPP,
	UNITID,
	GRPNUM,
        GRPSEN,
	NUMBININDEX,
	DEPEN,
	NUMTBLAPP,
	TBLAPPOPS,
	VARUNITNUM,
	VARUNITNUMS,
	VARUNITUBNUM,
	VARUNITUBNUMS,
	UNITFMT,
	UNITFMTS,
	VARUNITFMT,
	VARUNITFMTS,
        MODIFY,
        IMGFMT, 
        IMGTYPE, 
        IMGLATLOC, 
        IMGLONGLOC,
        IMGLATNUM,
        IMGLATUN,
        IMGLONGNUM,
        IMGLONGUN,
        IMGBIN, 
        IMGLATMIN, 
        IMGLATMAX,
        IMGLATDEL,
        IMGLONGMIN,
        IMGLONGMAX,
        IMGLONGDEL,
        IMGNUMSWPS,
        SWPNDX,
	IMGLATDEF,
	IMGLONGDEF,
	IMGSTORAGE,
	PIDFNUMS,
	VIDFNUMS,
        SCANSCFSEN,
        VSCANSCFSEN,
        VSCANUBSCFSEN,
        SRCFLAG,
        MOMENTMASS,
        VUNIT,
        VDIFFUNIT,
        MOMENTCHARGE,
        MOMENTSDEF,
        FLOWINTO,
        NUNITSUSEP,
        USEDUNITNUMS,
        CSDEFAULT,
        CSNUMTRANSFER,
        CSTRANSFERUNIT,
        CSDEF,
        TENSORDEF,
        TENSORRANK,
        DIMENNAME,
        DIMENID,
        DIMENSIZE,
        DIMENVALUES
} PIDF;

/* Valid data types */
/* These really ought to be defined as an enum, but its too late for that! */

#ifndef NOTUSED
#define NOTUSED -1
#endif
#ifndef SENSOR
#define SENSOR 1
#endif
#ifndef SWEEP_STEP
#define SWEEP_STEP 2
#endif
#ifndef CAL_DATA
#define CAL_DATA 3
#endif
#ifndef MODE
#define MODE 4
#endif
#ifndef D_QUAL
#define D_QUAL 5
#endif
#ifndef PITCH_ANGLE
#define PITCH_ANGLE 6
#endif
#ifndef START_AZ_ANGLE
#define START_AZ_ANGLE 7
#endif
#ifndef STOP_AZ_ANGLE
#define STOP_AZ_ANGLE 8
#endif
#ifndef SC_POTENTIAL
#define SC_POTENTIAL 9
#endif
#ifndef BACKGROUND
#define BACKGROUND 10
#endif
#ifndef MAX_DATA_TYPE
#define MAX_DATA_TYPE 10
#endif
#ifndef MASS
#define MASS 11
#endif
#ifndef PHI
#define PHI 12
#endif
#ifndef SCAN
#define SCAN 13
#endif
#ifndef THETA
#define THETA 14
#endif
#ifndef CHARGE
#define CHARGE 15
#endif
#ifndef PIDF_GROUP
#define PIDF_GROUP 101
#endif
#ifndef PIDF_UNITS
#define PIDF_UNITS 102
#endif
#ifndef AVG
#define AVG 112
#endif
#ifndef BIN
#define BIN 113
#endif
#ifndef IMAGE
#define IMAGE 114
#endif
#ifndef MOMENTS
#define MOMENTS 115
#endif
#ifndef COORD_SYSTEM
#define COORD_SYSTEM 116
#endif
#ifndef TENSOR
#define TENSOR 117
#endif

#endif

#ifndef ALL_OKAY
#define ALL_OKAY 1
#endif

#define MAX_PIDF_NAME 40

/* data mask bit decoders */

#define _BKGDMSK_  0x200 /* Background */
#define _SCPOTMSK_ 0x100 /* S/C Potential */
#define _STOPAZMSK_ 0x80 /* Stop Az */
#define _STARTAZMSK_ 0x40 /* Start Az */
#define _PMSK_ 0x20   /* Pitch Angle */
#define _SMSK_ 0x10   /* Sensor */
#define _TMSK_ 0x8   /* Sweep */
#define _CMSK_ 0x4   /* Cal Set */
#define _MMSK_ 0x2   /* Mode */
#define _QMSK_ 0x1   /* Data Quality */
#define _CHRG_  0x10 /* Charge */
#define _MASS_  0x08 /* Mass */
#define _PHI_   0x04 /* Phi */
#define _THETA_ 0x02 /* Theta */
#define _SCAN_  0x01 /* Scan */
#define _SCALAR_  0x1 /* Scalar */
#define _P_VECTOR_  0x2 /* Vector */
#define _ENG_ANGL_  0x4 /* Energy Angle */
#define _IMAGE_  0x8 /* Image */


#if defined(__cplusplus)
extern "C" {
#endif

SDDAS_INT ReadPidf (SDDAS_ULONG key, const char *Exten, SDDAS_INT DataType,
                    SDDAS_INT sennum, SDDAS_INT unitnum, PIDF what,
                    void *ToBeFilled);

/* int ReadNewPidf (SDDAS_ULONG, const char *, SDDAS_INT, SDDAS_INT, SDDAS_INT, PIDF, void *); */
void pidf_error_str (SDDAS_INT, char *);

/* Undocumented public functions - PLEASE DO NOT USE */

void PIDF_SetFileName (char *filename, char *vinst);
const char *PIDF_GetFileName ();

#if defined(__cplusplus)
}
#endif

#endif