Main Page | Files | Data Structures | Functions | Global Variables |
gpiv-genpar.h
Go to the documentation of this file.
1 /* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 c-style: "K&R" -*- */
2 
3 /*-----------------------------------------------------------------------------
4 
5  libgpiv - library for Particle Image Velocimetry
6 
7  Copyright (C) 2008 Gerber van der Graaf
8 
9  This file is part of libgpiv.
10 
11  Libgpiv is free software; you can redistribute it and/or modify
12  it under the terms of the GNU General Public License as published by
13  the Free Software Foundation; either version 2, or (at your option)
14  any later version.
15 
16  This program is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  GNU General Public License for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with this program; if not, write to the Free Software Foundation,
23  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 
25 -------------------------------------------------------------------------------
26 FILENAME: gpiv-genpar.h
27 LIBRARY: libgpiv:
28 EXTERNAL FUNCTIONS:
29 SOURCE: genpar.c
30  gpiv_genpar_parameters_set
31  gpiv_genpar_default_parameters
32  gpiv_genpar_fscan_parameters
33  gpiv_genpar_read_parameters
34  gpiv_genpar_check_parameters
35  gpiv_genpar_test_parameters
36  gpiv_genpar_print_parameters
37  gpiv_genpar_fprint_parameters
38  gpiv_genpar_cp_parameters
39 
40 
41 -----------------------------------------------------------------------------*/
52 #ifndef __LIBGPIV_GENPAR_H__
53 #define __LIBGPIV_GENPAR_H__
54 
55 #define GPIV_GENPAR_KEY "GENPAR"
58 typedef struct __GpivGenPar GpivGenPar;
59 
69 struct __GpivGenPar {
70  guint first_dir;
71  gboolean first_dir__set;
73  guint last_dir;
74  gboolean last_dir__set;
76  gboolean dir_prefix;
77  gboolean dir_prefix__set;
79  guint first_file;
80  gboolean first_file__set;
82  guint last_file;
83  gboolean last_file__set;
85  gboolean file_prefix;
86  gboolean file_prefix__set;
87 };
88 
89 
97 void
99  const gboolean flag
100  );
101 
102 
103 
111 void
113  const gboolean force
114  );
115 
116 
117 
127 void
128 gpiv_genpar_read_parameters (FILE *fp_h,
129  GpivGenPar *gen_par,
130  const gboolean print_par
131  );
132 
133 
134 
144 gchar *
146  const GpivGenPar *gen_par_default
147  );
148 
149 
150 
157 gchar *
159  );
160 
161 
162 
171 void
173  const GpivGenPar *gen_par
174  );
175 
176 
183 GpivGenPar *
185  );
186 
187 
188 
189 
190 #endif /* __LIBGPIV_GENPAR_H__ */
void gpiv_genpar_parameters_set(GpivGenPar *gen_par, const gboolean flag)
Sets flag for genpar__set.
GpivGenPar * gpiv_genpar_cp_parameters(const GpivGenPar *gen_par)
Copies general parameters.
gboolean file_prefix__set
flag if file_prefix has been defined
Definition: gpiv-genpar.h:86
guint last_dir
Last numbered directory to be scanned.
Definition: gpiv-genpar.h:73
Parameters for general purposes.
Definition: gpiv-genpar.h:69
void gpiv_genpar_print_parameters(FILE *fp, const GpivGenPar *gen_par)
Prints general parameters to file.
void gpiv_genpar_default_parameters(GpivGenPar *gen_par_default, const gboolean force)
Sets default parameter values.
gboolean first_dir__set
flag if first_dir has been defined
Definition: gpiv-genpar.h:71
gboolean first_file__set
flag if first_file has been defined
Definition: gpiv-genpar.h:80
guint first_file
First numbered file to be scanned.
Definition: gpiv-genpar.h:79
gboolean file_prefix
Use a prefix before the file basename.
Definition: gpiv-genpar.h:85
gboolean last_dir__set
flag if last_dir has been defined
Definition: gpiv-genpar.h:74
void gpiv_genpar_read_parameters(FILE *fp_h, GpivGenPar *gen_par, const gboolean print_par)
Reads general parameters.
guint last_file
Last numbered file to be scanned.
Definition: gpiv-genpar.h:82
gboolean dir_prefix__set
flag if dir_prefix has been defined
Definition: gpiv-genpar.h:77
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.
guint first_dir
First numbered directory to be scanned.
Definition: gpiv-genpar.h:70
gboolean last_file__set
flag if last_file has been defined
Definition: gpiv-genpar.h:83
gboolean dir_prefix
Use a prefix before the directory basename.
Definition: gpiv-genpar.h:76

Generated for libgpiv-0.6.1 by doxygen 1.8.13