Main Page | Files | Data Structures | Functions | Global Variables |
include/gpiv/gpiv-genpar.h
Go to the documentation of this file.
00001 /* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 c-style: "K&R" -*- */
00002 
00003 /*-----------------------------------------------------------------------------
00004 
00005    libgpiv - library for Particle Image Velocimetry
00006 
00007    Copyright (C) 2008 Gerber van der Graaf
00008 
00009    This file is part of libgpiv.
00010 
00011    Libgpiv is free software; you can redistribute it and/or modify
00012    it under the terms of the GNU General Public License as published by
00013    the Free Software Foundation; either version 2, or (at your option)
00014    any later version.
00015 
00016    This program is distributed in the hope that it will be useful,
00017    but WITHOUT ANY WARRANTY; without even the implied warranty of
00018    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019    GNU General Public License for more details.
00020 
00021    You should have received a copy of the GNU General Public License
00022    along with this program; if not, write to the Free Software Foundation,
00023    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  
00024 
00025 -------------------------------------------------------------------------------
00026 FILENAME:               gpiv-genpar.h
00027 LIBRARY:                libgpiv:
00028 EXTERNAL FUNCTIONS:
00029 SOURCE:                 genpar.c
00030                         gpiv_genpar_parameters_set
00031                         gpiv_genpar_default_parameters
00032                         gpiv_genpar_fscan_parameters
00033                         gpiv_genpar_read_parameters 
00034                         gpiv_genpar_check_parameters
00035                         gpiv_genpar_test_parameters
00036                         gpiv_genpar_print_parameters
00037                         gpiv_genpar_fprint_parameters
00038                         gpiv_genpar_cp_parameters
00039 
00040 
00041 -----------------------------------------------------------------------------*/
00052 #ifndef __LIBGPIV_GENPAR_H__
00053 #define __LIBGPIV_GENPAR_H__
00054 
00055 #define GPIV_GENPAR_KEY "GENPAR"       
00058 typedef struct __GpivGenPar GpivGenPar;
00059 
00069 struct __GpivGenPar {
00070     guint first_dir;            
00071     gboolean first_dir__set;    
00073     guint last_dir;             
00074     gboolean last_dir__set;     
00076     gboolean  dir_prefix;       
00077     gboolean dir_prefix__set;   
00079     guint first_file;           
00080     gboolean first_file__set;   
00082     guint last_file;            
00083     gboolean last_file__set;    
00085     gboolean file_prefix;       
00086     gboolean file_prefix__set;  
00087 };
00088 
00089 
00097 void
00098 gpiv_genpar_parameters_set (GpivGenPar                          *gen_par,
00099                 const gboolean                      flag
00100                 );
00101 
00102 
00103 
00111 void
00112 gpiv_genpar_default_parameters      (GpivGenPar             *gen_par_default,
00113                     const gboolean          force
00114                     );
00115 
00116 
00117 
00127 void
00128 gpiv_genpar_read_parameters     (FILE                   *fp_h, 
00129                     GpivGenPar      *gen_par, 
00130                     const gboolean      print_par
00131                     );
00132 
00133 
00134 
00144 gchar *
00145 gpiv_genpar_check_parameters_read   (GpivGenPar     *gen_par,
00146                     const GpivGenPar    *gen_par_default
00147                     );
00148 
00149 
00150 
00157 gchar *
00158 gpiv_genpar_test_parameters     (const GpivGenPar       *gen_par
00159                     );
00160 
00161 
00162 
00171 void
00172 gpiv_genpar_print_parameters        (FILE                   *fp, 
00173                     const GpivGenPar    *gen_par
00174                     );
00175 
00176 
00183 GpivGenPar *
00184 gpiv_genpar_cp_parameters       (const GpivGenPar       *gen_par
00185                     );
00186 
00187 
00188 
00189 
00190 #endif /* __LIBGPIV_GENPAR_H__ */