Main Page | Files | Data Structures | Functions | Global Variables |
gpiv-genpar.h File Reference

General parameters. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  __GpivGenPar
 Parameters for general purposes. More...
 

Macros

#define GPIV_GENPAR_KEY   "GENPAR"
 Key of general parameters. More...
 

Typedefs

typedef struct __GpivGenPar GpivGenPar
 

Functions

void gpiv_genpar_parameters_set (GpivGenPar *gen_par, const gboolean flag)
 Sets flag for genpar__set. More...
 
void gpiv_genpar_default_parameters (GpivGenPar *gen_par_default, const gboolean force)
 Sets default parameter values. More...
 
void gpiv_genpar_read_parameters (FILE *fp_h, GpivGenPar *gen_par, const gboolean print_par)
 Reads general parameters. More...
 
gchar * gpiv_genpar_check_parameters_read (GpivGenPar *gen_par, const GpivGenPar *gen_par_default)
 Checks if all necessary general parameters have been read. More...
 
gchar * gpiv_genpar_test_parameters (const GpivGenPar *gen_par)
 Tests general parameters on validity. More...
 
void gpiv_genpar_print_parameters (FILE *fp, const GpivGenPar *gen_par)
 Prints general parameters to file. More...
 
GpivGenPargpiv_genpar_cp_parameters (const GpivGenPar *gen_par)
 Copies general parameters. More...
 

Detailed Description

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.

Macro Definition Documentation

◆ GPIV_GENPAR_KEY

#define GPIV_GENPAR_KEY   "GENPAR"

Key of general parameters.

Definition at line 55 of file gpiv-genpar.h.

Typedef Documentation

◆ GpivGenPar

typedef struct __GpivGenPar GpivGenPar

Definition at line 58 of file gpiv-genpar.h.

Function Documentation

◆ 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_defaultgeneral parameters containing default values
[out]gen_parstructure of general parameters
Returns
NULL on success or error message on failure

◆ gpiv_genpar_cp_parameters()

GpivGenPar* gpiv_genpar_cp_parameters ( const GpivGenPar gen_par)

Copies general parameters.

Parameters
[in]genpar_pargeneral 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]forceflag to enforce parameters set to defaults
[out]gen_par_par_defaultstructure 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]flagflag to enforce parameters set to defaults
[out]gen_parimage 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]fpfile pointer to which paraeters will be printed. If NULL, stdout will be used
[in]gen_parstructure 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_hfile to be read
[in]gen_parpointer to structure of general parameters
[in]print_parprints parameters to stdout during reading
[out]general_parpointer 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_parstructure of general parameters
Returns
NULL on success or error message on failure

Generated for libgpiv-0.6.1 by doxygen 1.8.13