ConFM.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_FFI_CONFM_H
#define OSFI_FFI_CONFM_H
 
#include "ffi_base.h"
 
#ifdef __cplusplus
extern "C" {
#endif
// TODO: documentation! especially pre- and post- conditions, and what happens in
// case of a C++ exception.
 
OSFI_FFI_DECL_PLACEHOLDER(OSFI_ParamReader); 
OSFI_FFI_DECL_PLACEHOLDER(OSFI_Parameter); 
OSFI_FFI_DEPRECATED("Use the create_noval constructor instead and then call validate.")
OSFI_ParamReader* osfi_param_reader_create(const char* fileName, const char* schema);
OSFI_ParamReader* osfi_param_reader_create_noval(const char* fileName);
void osfi_param_reader_destroy(OSFI_ParamReader** obj);
 
enum osfi_ffi_confm_val_res {
    OSFI_FFI_CONFM_VAL_PASSED = 1,
    OSFI_FFI_CONFM_VAL_INVALID,
    OSFI_FFI_CONFM_VAL_ERRORS,
};
enum osfi_ffi_confm_val_res osfi_param_reader_valagainst(const OSFI_ParamReader* obj, const char* xsdFile);
 
void osfi_confm_print_parameters(const OSFI_ParamReader* obj);
bool osfi_confm_exist_parameter(const OSFI_ParamReader* obj, const char *paramName);
const OSFI_Parameter* osfi_confm_get_param(const OSFI_ParamReader* obj, const char *paramName);
// Nonexisting, because Parameter instances are held by ParamReader
// void osfi_parameter_destroy(OSFI_Parameter** obj);
 
enum osfi_confm_arrayorder {
    OSFI_CONFM_AO_LAST_CONTIG,
    OSFI_CONFM_AO_FIRST_CONTIG
};
 
#define OSFI_DECL_SCALAR_GETTER_simple(Tname, Ttype) \
 \
    bool osfi_confm_get_scalar_##Tname(const OSFI_Parameter* obj, Ttype* value)
#define OSFI_DECL_SCALAR_GETTER_str(Tname, Ttype) \
 \
    int osfi_confm_get_scalar_##Tname(const OSFI_Parameter* obj, Ttype buf, int bufSz)
 
// Declare getter functions: this macro declares the vector type, the available operations on it and
// the functions that get vector objects from a parameter object. Also, declare the scalar getter.
#define OSFI_DECL_GETTERS(Tname, Ttype, kind) \
    OSFI_DECL_SCALAR_GETTER_ ## kind(Tname, Ttype); \
    OSFI_DECL_VECTOR(Tname, Ttype, kind); \
 \
    OSFI_VEC_T(Tname) * osfi_confm_get_vector_##Tname##_vals(const OSFI_Parameter* obj, int* size); \
 \
    OSFI_VEC_T(Tname) * osfi_confm_get_leaf_vector_##Tname##_vals(const OSFI_Parameter* obj, const int node[], int depth, int* size); \
 \
    OSFI_VEC_T(Tname) * osfi_confm_get_matrix_##Tname##_vals(const OSFI_Parameter* obj, enum osfi_confm_arrayorder aeo, int* size);
 
OSFI_DECL_GETTERS(boolean, bool, simple);
OSFI_DECL_GETTERS(integer, int, simple);
OSFI_DECL_GETTERS(double, double, simple);
OSFI_DECL_GETTERS(time, OSFI_TimeValue, simple);
OSFI_DECL_GETTERS(file, char*, str); // NOTE: this could use the same type as OSFI_Vec_Tstring
OSFI_DECL_GETTERS(string, char*, str);
 
OSFI_VEC_T(boolean) * osfi_confm_file_exist(const OSFI_Parameter* p, enum osfi_confm_arrayorder aeo, int *size);
 
// Parameter information
int osfi_param_get_local_name(const OSFI_Parameter* obj, char* buf, int bufSz);
int osfi_param_get_path(const OSFI_Parameter* obj, char* buf, int bufSz);
int osfi_param_get_description(const OSFI_Parameter* obj, char* buf, int bufSz);
int osfi_param_get_min_value(const OSFI_Parameter* obj, char* buf, int bufSz);
int osfi_param_get_max_value(const OSFI_Parameter* obj, char* buf, int bufSz);
int osfi_param_get_units(const OSFI_Parameter* obj, char* buf, int bufSz);
int osfi_param_get_raw_value(const OSFI_Parameter* obj, char* buf, int bufSz);
 
enum OSFI_ParamElemType {
    OSFI_PET_INTEGER = 1,
    OSFI_PET_FLOAT,
    OSFI_PET_BOOLEAN,
    OSFI_PET_STRING,
    OSFI_PET_FILE,
    OSFI_PET_FOLDER,
    OSFI_PET_TIME,
};
enum OSFI_ParamElemType osfi_param_get_element_type(const OSFI_Parameter* obj);
 
bool osfi_param_is_array(const OSFI_Parameter* obj);
 
int osfi_confm_get_num_dims(const OSFI_Parameter* obj);
int osfi_confm_get_dimension(const OSFI_Parameter* obj, int index);
int osfi_confm_get_node_dimension(const OSFI_Parameter* obj, const int node[], int depth);
bool osfi_confm_is_leaf(const OSFI_Parameter* obj, const int node[], int depth);
 
// Miscellaneous Parameter-related functions
OSFI_FFI_DEPRECATED("unsafe function, writes into unknown-sized char buffers")
void osfi_confm_get_parameter(const OSFI_Parameter* obj, char *name, char *description, char* value,
    char *units, int dims[3], char *max, char *min, int *type);
void osfi_confm_print_parameter(const OSFI_Parameter* obj);
OSFI_VEC_T(string) * osfi_confm_list_all_params(const OSFI_ParamReader* obj);
OSFI_VEC_T(string) * osfi_confm_list_child_params(const OSFI_ParamReader* obj, const char* parentGrp);
 
int osfi_confm_compare_timevalue(const OSFI_TimeValue *a, const OSFI_TimeValue *b);
 
#ifdef __cplusplus
} // For the extern "C"
#endif
 
#endif /* OSFI_FFI_CONFM_H */