OSFIC.h

Go to the documentation of this file.

/*
 * openSF Integration Libraries (OSFI)
 * Deimos Space, S.L.U.
 * 
 * This file is part of OSFI. OSFI is free software; you can redistribute it
 * and/or modify it under the terms of the 'ESA Software Community Licence Permissive' as
 * published by the European Space Agency; either version 2.4 of the License,
 * or (at your option) any later version. You should have received a
 * copy of the 'ESA Software Community Licence Permissive - v2.4' along with this program
 * or one can be found at <http://eop-cfi.esa.int/index.php/docs-and-mission-data/licensing-documents>.
 */
 
#ifndef OSFI_C_INTERFACE
#define OSFI_C_INTERFACE 1
 
#include <stdbool.h>
#include <stdint.h>
 
# define MAX_LENGTH_FILE_NAME 255
# define MAX_LENGTH_STRING 255
# define MAX_PARAMETER_FIELD_SIZE 255
# define MAX_PARAMETER_NAME_SIZE 255
# define MAX_PARAMETER_DESC_SIZE 255
# define MAX_LOG_SIZE 1000
 
#if __STDC_VERSION__ >= 201112L
    #define OSFI_NO_RETURN _Noreturn /* In C11: keyword */
#else
    #define OSFI_NO_RETURN /* Below C11: nothing */
#endif
 
typedef enum
{
    ParamInteger = 1,
    ParamDouble,
    ParamBoolean,
    ParamString,
    ParamFile,
    ParamFolder,
    ParamTime
} ParamType;
 
typedef struct {
    char *name;
    char *description;
    char *value;
    char *units;
    int dims[2];
    char *min;
    char *max;
    ParamType type;
} osfiParameter;
 
// EHLog module
 
void osfiLoggerError(const char *format,...);
 
void osfiLoggerWarning(const char *format,...);
 
void osfiLoggerInfo(const char *format,...);
 
void osfiLoggerDebug(const char *format,...);
 
void osfiLoggerProgress(int n, int m);
 
OSFI_NO_RETURN void osfiLoggerFinishExecution(int errorCode);
 
void osfiLoggerQuality(const char *name, const char *value);
 
void osfiLoggerQualityDouble(const char *name, double value);
 
int osfiCLP(int argc, char *argv[]);
 
void osfiCLPGetConfFile(char * fileName, int *length);
 
void osfiCLPGetConfFiles(char *confFiles[], int *noFiles);
 
void osfiCLPGetInputFiles(char *inputFiles[], int *noFiles);
 
void osfiCLPGetOutputFiles(char *outputFiles[], int *noFiles);
 
// ConFM Module
 
int osfiConFMParamReader(const char *fileName, const char *schemaName);
 
bool osfiConFMReadConfigFile(const char *fileName);
 
enum osfi_confm_val_res {
    OSFI_CONFM_VAL_PASSED = 1,
    OSFI_CONFM_VAL_INVALID,
    OSFI_CONFM_VAL_ERRORS,
};
 
enum osfi_confm_val_res osfiConFMValidateAgainst(const char* schemaFile);
 
void osfiConFMPrintParameters();
 
typedef struct osfi_timevalue {
    int16_t year; 
    int8_t month; 
    int8_t dom; 
    int8_t hour; 
    int8_t minute; 
    int8_t sec; 
    int32_t nanosec; 
} osfi_timevalue_t;
 
int osfiTimevalue_cmp(const osfi_timevalue_t *a, const osfi_timevalue_t *b);
 
void osfiConFMGetIntegerValue(int *value, const char *paramName);
 
void osfiConFMGetDoubleValue(double *value, const char *paramName);
 
void osfiConFMGetTimeValue(osfi_timevalue_t *value, const char *paramName);
 
bool osfiConFMGetBoolValue(const char *paramName);
 
void osfiConFMGetFileValue(char *param, int *length, const char *paramName);
 
void osfiConFMGetStringValue(char *param, int *length, const char *paramName);
 
void osfiConFMGetParameter(osfiParameter *param, const char *paramName);
 
void osfiConFMPrintParameter(const char *paramName);
 
void osfiConFMGetVectorDoubleValues(double *doubleList, int *size,
    const char *paramName);
 
void osfiConFMGetVectorIntegerValues(int *intList, int *size, const char *paramName);
 
void osfiConFMGetVectorTimeValues(osfi_timevalue_t *list, int *size, const char *paramName);
 
void osfiConFMGetVectorStringValues(char *stringList[], int *size, const char *paramName);
 
void osfiConFMGetVectorFileValues(char *fileList[], int *size, const char *paramName);
 
void osfiConFMGetVectorBooleanValues(bool *boolList, int *size, const char *paramName);
 
void osfiConFMGetLeafVectorDoubleValues(double *doubleList, int *size,
    const char *paramName, int node[], int depth);
 
void osfiConFMGetLeafVectorIntegerValues(int *intList, int *size, const char *paramName, int node[], int depth);
 
void osfiConFMGetLeafVectorTimeValues(osfi_timevalue_t *list, int *size, const char *paramName, int node[], int depth);
 
void osfiConFMGetLeafVectorStringValues(char *stringList[], int *size, const char *paramName, int node[], int depth);
 
void osfiConFMGetLeafVectorFileValues(char *fileList[], int *size, const char *paramName, int node[], int depth);
 
void osfiConFMGetLeafVectorBooleanValues(bool *boolList, int *size, const char *paramName, int node[], int depth);
 
void osfiConFMGetMatrixStringValues(char *stringMatrix[], int *rows, int *columns, const char *paramName);
 
void osfiConFMGetMatrixFileValues(char *fileMatrix[], int *rows, int *columns, const char *paramName);
 
void osfiConFMGetMatrixBooleanValues(bool *booleanMatrix, int *rows, int *columns, const char *paramName);
 
void osfiConFMfileExist(bool *booleanMatrix, int *rows, int *columns, const char *paramName);
 
void osfiConFMGetMatrixDoubleValues(double *doubleMatrix, int *rows,
    int *columns, const char *paramName);
 
void osfiConFMGetMatrixIntegerValues(int *intMatrix, int *rows, int *columns,
    const char *paramName);
 
void osfiConFMGetMatrixTimeValues(osfi_timevalue_t *intMatrix, int *rows, int *columns,
    const char *paramName);
 
void osfiConFMGetDimension(const char *paramName, int index, int *size);
 
void osfiConFMGetNodeDimension(const char *paramName, int node[], int depth, int *size);
 
bool osfiConFMIsLeaf(const char *paramName, int node[], int depth);
int osfiConFMGetRows(const char *paramName);
 
int osfiConFMGetColumns(const char *paramName);
 
bool osfiConFMExistParameter(const char *paramName);
 
ParamType osfiConFMGetElementType(const char* paramName);
bool osfiConFMIsArray(const char* paramName);
 
int osfiCommonClose();
 
#endif // !defined(OSFI_C_INTERFACE)