General parameters.
More...
Go to the source code of this file.
General parameters.
SOURCE: lib/genpar.c
LAST MODIFICATION DATE:
- Id
- gpiv-genpar.h,v 1.1 2008-04-22 12:58:02 gerber Exp
Definition in file gpiv-genpar.h.
◆ GPIV_GENPAR_KEY
#define GPIV_GENPAR_KEY "GENPAR" |
◆ GpivGenPar
◆ gpiv_genpar_check_parameters_read()
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.
- Parameters
-
[in] | gen_par_default | general parameters containing default values |
[out] | gen_par | structure of general parameters |
- Returns
- NULL on success or error message on failure
◆ gpiv_genpar_cp_parameters()
Copies general parameters.
- Parameters
-
[in] | genpar_par | general parameters to be copied |
- Returns
- GpivGenPar or NULL on failure
◆ gpiv_genpar_default_parameters()
void gpiv_genpar_default_parameters |
( |
GpivGenPar * |
gen_par_default, |
|
|
const gboolean |
force |
|
) |
| |
Sets default parameter values.
- Parameters
-
[in] | force | flag to enforce parameters set to defaults |
[out] | gen_par_par_default | structure of general parameters |
- Returns
- void
◆ gpiv_genpar_parameters_set()
void gpiv_genpar_parameters_set |
( |
GpivGenPar * |
gen_par, |
|
|
const gboolean |
flag |
|
) |
| |
Sets flag for genpar__set.
- Parameters
-
[in] | flag | flag to enforce parameters set to defaults |
[out] | gen_par | image processing parameters |
- Returns
- void
◆ gpiv_genpar_print_parameters()
void gpiv_genpar_print_parameters |
( |
FILE * |
fp, |
|
|
const GpivGenPar * |
gen_par |
|
) |
| |
Prints general parameters to file.
- Parameters
-
[in] | fp | file pointer to which paraeters will be printed. If NULL, stdout will be used |
[in] | gen_par | structure of general parameters |
- Returns
- void
◆ gpiv_genpar_read_parameters()
void gpiv_genpar_read_parameters |
( |
FILE * |
fp_h, |
|
|
GpivGenPar * |
gen_par, |
|
|
const gboolean |
print_par |
|
) |
| |
Reads general parameters.
- 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 |
- Returns
- void
◆ gpiv_genpar_test_parameters()
gchar* gpiv_genpar_test_parameters |
( |
const GpivGenPar * |
gen_par | ) |
|
Tests general parameters on validity.
- Parameters
-
[in] | gen_par | structure of general parameters |
- Returns
- NULL on success or error message on failure