productInfo.h

Go to the documentation of this file.

#ifndef PRODUCT_INFO_H
#define PRODUCT_INFO_H
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* default values for the product info structure */
 
#define PRODUCT_DEFAULT_description "no description"
#define PRODUCT_DEFAULT_units "unspecified"
#define PRODUCT_DEFAULT_palette "default"
#define PRODUCT_DEFAULT_paramDesignator "none"
#define PRODUCT_DEFAULT_paramWaveMin -1
#define PRODUCT_DEFAULT_paramWaveMax -1
#define PRODUCT_DEFAULT_standardName NULL
#define PRODUCT_DEFAULT_category "Miscellaneous"
#define PRODUCT_DEFAULT_dataType "float"
#define PRODUCT_DEFAULT_prefix NULL
#define PRODUCT_DEFAULT_suffix NULL
#define PRODUCT_DEFAULT_algorithmName ""
#define PRODUCT_DEFAULT_productName ""
#define PRODUCT_DEFAULT_cat_ix -1
#define PRODUCT_DEFAULT_prod_ix -1
#define PRODUCT_DEFAULT_rank 2
#define PRODUCT_DEFAULT_fillValue -32767
#define PRODUCT_DEFAULT_fillValue_byte -1
#define PRODUCT_DEFAULT_fillValue_ubyte 0xFF
#define PRODUCT_DEFAULT_fillValue_ushort 0xFFFF
#define PRODUCT_DEFAULT_fillValue_uint 0xFFFFFFFF
#define PRODUCT_DEFAULT_validMin 0
#define PRODUCT_DEFAULT_validMax 0
#define PRODUCT_DEFAULT_displayScale "linear"
#define PRODUCT_DEFAULT_displayMin 0
#define PRODUCT_DEFAULT_displayMax 0
#define PRODUCT_DEFAULT_scaleFactor 1
#define PRODUCT_DEFAULT_addOffset 0
#define PRODUCT_DEFAULT_reference NULL
#define PRODUCT_DEFAULT_comment NULL
#define PRODUCT_DEFAULT_titleFormat "no format string"
 
typedef struct productInfo_str {
    char *description; 
    char *units; 
    char *palette; 
    char *paramDesignator; 
    int paramWaveMin; 
    int paramWaveMax; 
    char *standardName; 
    char *category; 
    char *dataType; 
    char *prefix; 
    char *suffix; 
    char *algorithmName; 
    char *productName; 
    int cat_ix; 
    int prod_ix; 
    int rank; 
    double fillValue; 
    double validMin; 
    double validMax; 
    char *displayScale; 
    double displayMin; 
    double displayMax; 
    double scaleFactor; 
    double addOffset; 
    char *reference; 
    char *comment; 
    char *titleFormat; 
} productInfo_t;
 
 
/*
 * function prototypes
 */
 
void clearProductInfo(productInfo_t* info);
void initProductInfo(productInfo_t* info);
productInfo_t* allocateProductInfo();
void freeProductInfo(productInfo_t* info);
void copyProductInfo(productInfo_t* dest, const productInfo_t* src);
void getFirstProductInfo(productInfo_t* info);
int getNextProductInfo(productInfo_t* info);
int findProductInfo(const char* name, int sensorId, productInfo_t* info);
char* getProductNameFull(productInfo_t* info);
void printProductInfo(const char* productFullName, const productInfo_t* info);
const char* getDOI(const char* platform, const char* sensor, const char* level,
        const char* suite, const char* version);
const char* getGCMDKeywords(const char* suite);
 
#ifdef __cplusplus
}
#endif
 
#endif