grasp_settings.h File Reference
Main interface binded for input settings. More...
#include <stdbool.h>#include "yamlsettings/yamlsettings_dictionary.h"#include "mod_par_OS.inc"#include "mod_par_inv.inc"#include "../retrieval/constants_set/mod_globals.inc"#include "../input/grasp_input_settings.h"#include "../controller/grasp_controller_settings.h"#include "../output/grasp_output_settings.h"#include "../settings/grasp_products.h"#include "../global/grasp_parameters.h"#include "grasp_settings_t.h"#include "../output/grasp_output_stream_t.h"Go to the source code of this file.
Data Structures | |
| struct | grasp_settings_parameter_array_ |
Macros | |
| #define | RESOURCES_PREFIX "/usr/local/grasp-resources/" |
Typedefs | |
| typedef struct grasp_settings_parameter_array_ | grasp_settings_parameter_array |
Functions | |
| yamlsettings_dictionary_t * | grasp_settings_dictionary_get (grasp_settings *settings) |
| int | grasp_settings_read (grasp_output_stream *controller_stream, yamlsettings_dictionary_t **dictionary, int nparameters, char const *parameters[], yamlsettings_parser_settings_file_mode settings_file_mode) |
| grasp_settings_parameter_array * | grasp_settings_parameter_array_allocate (int nelements) |
| void | grasp_settings_parameter_array_destroy (grasp_settings_parameter_array *x) |
| void | grasp_settings_help (grasp_output_stream *controller_stream, const char *filter) |
| void | grasp_settings_destroy (grasp_settings *settings) |
| void | grasp_settings_postprocess_function (yamlsettings_dictionary_t *dictionary) |
| int | grasp_settings_to_yaml_string (char content[], grasp_settings *settings, bool print_defaults, bool force_arrays) |
| int | grasp_settings_description_json (char *json, int json_length) |
| int | grasp_settings_dump (char *stream_pattern, grasp_settings *settings, bool print_defaults, bool force_arrays) |
| int | grasp_settings_deduct_nwl (yamlsettings_dictionary_t *dictionary) |
| char * | grasp_settings_list_paths () |
| char * | grasp_settings_to_string (const char *filename) |
Detailed Description
Main interface binded for input settings.
- Date
- August, 2013 Here is defined option parameters and main functions for retrieved it from a configuration file
Macro Definition Documentation
◆ RESOURCES_PREFIX
| #define RESOURCES_PREFIX "/usr/local/grasp-resources/" |
Typedef Documentation
◆ grasp_settings_parameter_array
| typedef struct grasp_settings_parameter_array_ grasp_settings_parameter_array |
Function Documentation
◆ grasp_settings_deduct_nwl()
| int grasp_settings_deduct_nwl | ( | yamlsettings_dictionary_t * | dictionary | ) |
◆ grasp_settings_description_json()
| int grasp_settings_description_json | ( | char * | json, |
| int | json_length | ||
| ) |
◆ grasp_settings_destroy()
| void grasp_settings_destroy | ( | grasp_settings * | settings | ) |
◆ grasp_settings_dictionary_get()
| yamlsettings_dictionary_t* grasp_settings_dictionary_get | ( | grasp_settings * | settings | ) |
◆ grasp_settings_dump()
| int grasp_settings_dump | ( | char * | stream_pattern, |
| grasp_settings * | settings, | ||
| bool | print_defaults, | ||
| bool | force_arrays | ||
| ) |
Function which dumps grasp settings in yaml format
- Parameters
-
stream_pattern Patter to initialize grasp_output_stream settings Current settings you want to dump print_defaults if you want to print default values or you prefer a reduced settings file based on only set information
- Returns
- 0 if everything was ok, otherwise a value different than 0
◆ grasp_settings_help()
| void grasp_settings_help | ( | grasp_output_stream * | controller_stream, |
| const char * | filter | ||
| ) |
◆ grasp_settings_list_paths()
| char* grasp_settings_list_paths | ( | ) |
◆ grasp_settings_parameter_array_allocate()
| grasp_settings_parameter_array* grasp_settings_parameter_array_allocate | ( | int | nelements | ) |
◆ grasp_settings_parameter_array_destroy()
| void grasp_settings_parameter_array_destroy | ( | grasp_settings_parameter_array * | x | ) |
◆ grasp_settings_postprocess_function()
| void grasp_settings_postprocess_function | ( | yamlsettings_dictionary_t * | dictionary | ) |
◆ grasp_settings_read()
| int grasp_settings_read | ( | grasp_output_stream * | controller_stream, |
| yamlsettings_dictionary_t ** | dictionary, | ||
| int | nparameters, | ||
| char const * | parameters[], | ||
| yamlsettings_parser_settings_file_mode | settings_file_mode | ||
| ) |
◆ grasp_settings_to_string()
| char* grasp_settings_to_string | ( | const char * | filename | ) |
◆ grasp_settings_to_yaml_string()
| int grasp_settings_to_yaml_string | ( | char | content[], |
| grasp_settings * | settings, | ||
| bool | print_defaults, | ||
| bool | force_arrays | ||
| ) |