General parameters. More...
Go to the source code of this file.
Data Structures | |
struct | __GpivGenPar |
Parameters for general purposes. More... | |
Defines | |
#define | GPIV_GENPAR_KEY "GENPAR" |
Key of general parameters. | |
Typedefs | |
typedef struct __GpivGenPar | GpivGenPar |
Functions | |
void | gpiv_genpar_parameters_set (GpivGenPar *gen_par, const gboolean flag) |
Sets flag for genpar__set. | |
void | gpiv_genpar_default_parameters (GpivGenPar *gen_par_default, const gboolean force) |
Sets default parameter values. | |
void | gpiv_genpar_read_parameters (FILE *fp_h, GpivGenPar *gen_par, const gboolean print_par) |
Reads general parameters. | |
gchar * | gpiv_genpar_check_parameters_read (GpivGenPar *gen_par, const GpivGenPar *gen_par_default) |
Checks if all necessary general parameters have been read. | |
gchar * | gpiv_genpar_test_parameters (const GpivGenPar *gen_par) |
Tests general parameters on validity. | |
void | gpiv_genpar_print_parameters (FILE *fp, const GpivGenPar *gen_par) |
Prints general parameters to file. | |
GpivGenPar * | gpiv_genpar_cp_parameters (const GpivGenPar *gen_par) |
Copies general parameters. |
General parameters.
SOURCE: lib/genpar.c
LAST MODIFICATION DATE:
Definition in file gpiv-genpar.h.
#define GPIV_GENPAR_KEY "GENPAR" |
Key of general parameters.
Definition at line 55 of file gpiv-genpar.h.
typedef struct __GpivGenPar GpivGenPar |
Definition at line 58 of file gpiv-genpar.h.
gchar* gpiv_genpar_check_parameters_read | ( | GpivGenPar * | gen_par, | |
const GpivGenPar * | gen_par_default | |||
) |
Checks if all necessary general parameters have been read.
If a parameter has not been read, it will be set to gen_par_default or to its hard-coded default value in case gen_par_default is NULL.
[in] | gen_par_default | general parameters containing default values |
[out] | gen_par | structure of general parameters |
GpivGenPar* gpiv_genpar_cp_parameters | ( | const GpivGenPar * | gen_par | ) |
Copies general parameters.
[in] | genpar_par | general parameters to be copied |
void gpiv_genpar_default_parameters | ( | GpivGenPar * | gen_par_default, | |
const gboolean | force | |||
) |
Sets default parameter values.
[in] | force | flag to enforce parameters set to defaults |
[out] | gen_par_par_default | structure of general parameters |
void gpiv_genpar_parameters_set | ( | GpivGenPar * | gen_par, | |
const gboolean | flag | |||
) |
Sets flag for genpar__set.
[in] | flag | flag to enforce parameters set to defaults |
[out] | gen_par | image processing parameters |
void gpiv_genpar_print_parameters | ( | FILE * | fp, | |
const GpivGenPar * | gen_par | |||
) |
Prints general parameters to file.
[in] | fp | file pointer to which paraeters will be printed. If NULL, stdout will be used |
[in] | gen_par | structure of general parameters |
void gpiv_genpar_read_parameters | ( | FILE * | fp_h, | |
GpivGenPar * | gen_par, | |||
const gboolean | print_par | |||
) |
Reads general parameters.
[in] | fp_h | file to be read |
[in] | gen_par | pointer to structure of general parameters |
[in] | print_par | prints parameters to stdout during reading |
[out] | general_par | pointer to structure of general parameters |
gchar* gpiv_genpar_test_parameters | ( | const GpivGenPar * | gen_par | ) |
Tests general parameters on validity.
[in] | gen_par | structure of general parameters |