ppf_genref.h

read envisat and analyis sar data from NASA

#ifndef _PPF_LIB_H
#include <ppf_lib.h>
#endif

#ifndef _PPF_ORBIT_H
#include <ppf_lib.h>
#endif

#ifndef _PPF_POINTING_H
#include <ppf_lib.h>
#endif

#ifndef _PPF_GENREF_H
#define _PPF_GENREF_H


#ifdef __cplusplus
extern "C"
{
#endif

/* This version number is the SCCS version number valid only for internal configuration and control. */
/* The oficial version number can be found in the History box below. */

static char PPF_GENREF_H [] = "@(#)ppf_genref.h	1.8 05/20/05";

/*****************************************************************************
 * 
 * Copyright	: DEIMOS Space S.L.
 * Project	: REMASE
 * 
 * Module	: ppf_genref.h
 * Purpose	: It is the header file of the PPF_GENREF CFI to be used 
 *                by the final user
 *
 * History	+------------------------------------------------------------+
 *		| Version | Date     | Name         | Change                 |
 *		|---------|----------|--------------|------------------------|
 *		|    2.1  | 05/12/97 |   GMV, S.A   | First release          |
 *		|    2.2  | 18/05/98 |   GMV, S.A   | Second release         |
 *		|    2.3  | 13/10/98 |   GMV, S.A   | Third release          |
 *		|    2.4  | 25/05/99 |   GMV, S.A   | Fourth release         |
 *		|    2.5  | 14/04/00 |   GMV, S.A   | Fifth release          |
 *		|    2.6  | 22/06/01 |   GMV, S.A   | Sixth release          |
 *		|    2.7  | 31/07/01 |   GMV, S.A   | Seventh release        |
 *		|    2.8  | 22/10/01 | DEIMOS Space | Eigth release          |
 *		|    3.0  | 18/01/02 | DEIMOS Space | Ninth release          |
 *		|    3.1  | 25/11/02 | DEIMOS Space | Tenth release          |
 *		|    3.2  | 26/05/03 | DEIMOS Space | Eleventh release       |
 *              |    3.3  | 13/12/04 | DEIMOS Space | Twelfth release        |
 *              |   3.3.1 | 15/02/05 | DEIMOS Space | Thirteenth release     |
 *              |    3.4  | 17/05/05 | DEIMOS Space | Forteenth release      |
 *		+------------------------------------------------------------+
 * 
 ****************************************************************************/

/* Main CFI Functions - prototype declaration */
/* ========================================== */

long pg_genoef(char *osf, long *start_orb, long *stop_orb,
               char *ref_oef, long ierr[]);

long pg_genswath(char *osf, long *req_orb, char *swath_def_fil, 
                 char *instr_swath_file_suff, long *rep_cycl, 
                 long *cycle_length, long ierr[]);
 
/* Error Handling Functions - prototype declaration */
/* ================================================ */

#define PG_MAX_COD PL_MAX_COD
#define PG_MAX_STR PL_MAX_STR

long pg_silent(void);

long pg_verbose(void);

long pg_print_msg(long *n, char msg[PG_MAX_COD][PG_MAX_STR]);

long pg_vector_msg(long *func_id, long *ierr, long *n, char msg[PG_MAX_COD][PG_MAX_STR]);

long pg_vector_code(long *func_id, long *ierr, long *n, long vec[PG_MAX_COD]);


/* Modes and switches */
/* ================== */

/* Returned status code */
/* -------------------- */

typedef enum
{

PG_ERR  = PL_ERR,     /* Error status */
PG_OK   = PL_OK,      /* Nominal status */
PG_WARN = PL_WARN     /* Warning status */

}PG_PErr_type_enum;   /* CAREFUL: variables holding these values MUST be declared as long !!! */


/* CFI functions IDs (for error handling) */
/* ====================================== */ 

typedef enum
{
 
 PG_NO_FUNC_ID = -1,              /* No function code */
 PG_GENOEF_ID,
 PG_GENSWATH_ID,
 PG_MAX_FUNC_ID                   /* Number of functions defined in this list */
 
} PG_Func_enum;

/* List of errors of the main CFI functions (Look up the PPF_GENREF SUM) */
/* ===================================================================== */
 
/* Error codes list of pg_genoef */
/* ----------------------------- */

typedef enum                            
{
   /* Errors and warnings related with input and output parameters checking */
   PG_CFI_GENOEF_OSF_WRONG_ERR = PL_ZERO_E,
   PG_CFI_GENOEF_OSF_INFO_OPEN_ERR,
   PG_CFI_GENOEF_OSF_INFO_WRITE_ERR,
   PG_CFI_GENOEF_OSF_OPEN_ERR,
   PG_CFI_GENOEF_SOBM_OPEN_ERR,
   PG_CFI_GENOEF_OEF_OPEN_ERR,
   PG_CFI_GENOEF_PG_OSF_REC_READ_ERR,
   PG_CFI_GENOEF_ABS_ORB_COUNT_ERR,
   PG_CFI_GENOEF_PG_ORB_CHANG_ERR,
   PG_CFI_GENOEF_SOBM_ENTR_EXIT_ERR,
   PG_CFI_GENOEF_SOBM_WRITE_ERR,
   PG_CFI_GENOEF_SOBM_1ST_ORB_WARN,
   PG_CFI_GENOEF_SOBM_1ST_ORB_ERR,
   PG_CFI_GENOEF_PG_OEF_REC_WRITE_ERR,
   PG_CFI_GENOEF_VHR_OPEN_ERR,
   PG_CFI_GENOEF_OEF_BEG_WRITE_ERR,
   PG_CFI_GENOEF_PG_OEF_VHR_WRITE_ERR,
   PG_CFI_GENOEF_SOBM_END_WRITE_ERR,
   PG_CFI_GENOEF_OEF_END_WRITE_ERR,

   /* Errors and warnings related with internal processing */
   PG_CFI_GENOEF_PG_OSF_CHECK_ERR = PL_FIRST_E,
   PG_CFI_GENOEF_PG_OSF_CHECK_NTH_ERR,
   PG_CFI_GENOEF_PG_ORB_REC_COPY_ERR,
   PG_CFI_GENOEF_PG_GENSTATE_ERR,
   PG_CFI_GENOEF_PG_ECLIPSE_ERR,
   PG_CFI_GENOEF_PG_SUN_ZEN_ANGL_ERR,
   PG_CFI_GENOEF_PG_SUN_ZEN_ANGL_SZA_MAX_ERR,
   PG_CFI_GENOEF_PG_SUN_ZEN_ANGL_SZA_MIN_ERR,
   PG_CFI_GENOEF_PG_SUN_OCC_BY_MOON_ERR,
   PG_CFI_GENOEF_PG_SUN_OCC_BY_MOON_WARN,
   PG_CFI_GENOEF_PG_FILENAME_GENER_ERR,
   PG_CFI_GENOEF_PG_FHR_WRITE_ERR,

   PG_CFI_GENOEF_CAT_FILES_ERR,
   PG_CFI_GENOEF_REMOVE_FILES_ERR,
   PG_CFI_GENOEF_SOBM_LAST_ORBIT_WARN,
   PG_CFI_GENOEF_SOBM_LAST_ORBIT_ERR

} PG_CFI_Genoef_err_enum;

typedef enum                            
{
   /* Errors and warnings related with internal processing */

   PG_CFI_GENSWATH_OPEN_SDF_ERR = PL_ZERO_E,
   PG_CFI_GENSWATH_STF_FILENAMES_ERR,
   PG_CFI_GENSWATH_SWATH_ID_CYCL_LENGTH_1ST_ERR,
   PG_CFI_GENSWATH_SWATH_ID_CYCL_LENGTH_2ND_ERR,
   PG_CFI_GENSWATH_OPEN_STF_WRITE_ERR,
   PG_CFI_GENSWATH_STF_BEG_WRITE_ERR,
   PG_CFI_GENSWATH_COMM_LINE_ERR,
   PG_CFI_GENSWATH_RENAME_FILES_ERR,

   /* Errors and warnings related with calls to other functions */

   PG_CFI_GENSWATH_PG_CHECK_GENSW_INP_ERR = PL_FIRST_E,
   PG_CFI_GENSWATH_PG_GENSTATE_ERR,
   PG_CFI_GENSWATH_PG_SDF_PREV_CHECK_ERR,
   PG_CFI_GENSWATH_PG_SDF_PREV_CHECK_SWATH_VALUE_ERR,
   PG_CFI_GENSWATH_PG_SDF_PREV_CHECK_SWATH_RECORD_ERR,
   PG_CFI_GENSWATH_PG_SDF_READ_HEADER_ERR,
   PG_CFI_GENSWATH_PG_SDF_REC_READ_ERR,
   PG_CFI_GENSWATH_PG_ALGOR_ERR,
   PG_CFI_GENSWATH_PG_FILENAME_GENER_SWATH_ERR,
   PG_CFI_GENSWATH_PG_FHR_WRITE_ERR,
   PG_CFI_GENSWATH_PG_STF_VHR_WRITE_ERR

} PG_CFI_Genswath_err_enum;


/* Functions names aliases (historical names LEFT - official names RIGHT) */
/* ====================================================================== */

#define PG_Silent               pg_silent
#define PG_Verbose              pg_verbose
#define PG_Print_Msg            pg_print_msg
#define PG_Vector_Msg           pg_vector_msg
#define PG_Vector_Code          pg_vector_code

#define genoef    		pg_genoef
#define genswath		pg_genswath

/**************************************************************************/

/* Constant values */
/* --------------- */
#define PG_MAX_NUM_SZA      10  /* Maximum number of requested SZA times in OSF */
#define PG_MAX_LENGTH      256  /* Maximum number of characters between quotes in input files */
#define PG_MAX_LINE_LENGTH 512  /* Maximum number of characters in a line for an input file (before
                               new line character) */

#ifdef __cplusplus
}
#endif


#endif