ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/trunk/src/applications/staticProps/StaticPropsCmd.h
Revision: 1782
Committed: Wed Aug 22 02:28:28 2012 UTC (12 years, 8 months ago) by gezelter
Content type: text/plain
File size: 17989 byte(s)
Log Message: 
MERGE OpenMD development branch 1465:1781 into trunk

File Contents

# User Rev Content
1 gezelter 1390 /** @file StaticPropsCmd.h
2     * @brief The header file for the command line option parser
3 kstocke1 1531 * generated by GNU Gengetopt version 2.22.4
4 gezelter 1390 * http://www.gnu.org/software/gengetopt.
5     * DO NOT modify this file, since it can be overwritten
6     * @author GNU Gengetopt by Lorenzo Bettini */
7 tim 310
8     #ifndef STATICPROPSCMD_H
9     #define STATICPROPSCMD_H
10    
11     /* If we use autoconf. */
12     #ifdef HAVE_CONFIG_H
13     #include "config.h"
14     #endif
15    
16 gezelter 1390 #include <stdio.h> /* for FILE */
17    
18 tim 310 #ifdef __cplusplus
19     extern "C" {
20     #endif /* __cplusplus */
21    
22     #ifndef CMDLINE_PARSER_PACKAGE
23 kstocke1 1531 /** @brief the program name (used for printing errors) */
24 tim 311 #define CMDLINE_PARSER_PACKAGE "StaticProps"
25 tim 310 #endif
26    
27 kstocke1 1531 #ifndef CMDLINE_PARSER_PACKAGE_NAME
28     /** @brief the complete program name (used for help and version) */
29     #define CMDLINE_PARSER_PACKAGE_NAME "StaticProps"
30     #endif
31    
32 tim 310 #ifndef CMDLINE_PARSER_VERSION
33 gezelter 1390 /** @brief the program version */
34 tim 310 #define CMDLINE_PARSER_VERSION "1.00"
35     #endif
36    
37 gezelter 1390 /** @brief Where the command line options are stored */
38 tim 543 struct gengetopt_args_info
39     {
40 gezelter 1390 const char *help_help; /**< @brief Print help and exit help description. */
41     const char *version_help; /**< @brief Print version and exit help description. */
42     char * input_arg; /**< @brief input dump file. */
43     char * input_orig; /**< @brief input dump file original value given at command line. */
44     const char *input_help; /**< @brief input dump file help description. */
45     char * output_arg; /**< @brief output file name. */
46     char * output_orig; /**< @brief output file name original value given at command line. */
47     const char *output_help; /**< @brief output file name help description. */
48     int step_arg; /**< @brief process every n frame (default='1'). */
49     char * step_orig; /**< @brief process every n frame original value given at command line. */
50     const char *step_help; /**< @brief process every n frame help description. */
51     int nbins_arg; /**< @brief number of bins (general purpose) (default='100'). */
52     char * nbins_orig; /**< @brief number of bins (general purpose) original value given at command line. */
53     const char *nbins_help; /**< @brief number of bins (general purpose) help description. */
54     int nbins_x_arg; /**< @brief number of bins in x axis (default='100'). */
55     char * nbins_x_orig; /**< @brief number of bins in x axis original value given at command line. */
56     const char *nbins_x_help; /**< @brief number of bins in x axis help description. */
57     int nbins_y_arg; /**< @brief number of bins in y axis (default='100'). */
58     char * nbins_y_orig; /**< @brief number of bins in y axis original value given at command line. */
59     const char *nbins_y_help; /**< @brief number of bins in y axis help description. */
60 gezelter 1440 int nbins_z_arg; /**< @brief number of bins in z axis (default='100'). */
61     char * nbins_z_orig; /**< @brief number of bins in z axis original value given at command line. */
62     const char *nbins_z_help; /**< @brief number of bins in z axis help description. */
63 gezelter 1390 int nanglebins_arg; /**< @brief number of bins for cos(angle) (default='50'). */
64     char * nanglebins_orig; /**< @brief number of bins for cos(angle) original value given at command line. */
65     const char *nanglebins_help; /**< @brief number of bins for cos(angle) help description. */
66 chuckv 1445 double rcut_arg; /**< @brief cutoff radius (rcut). */
67     char * rcut_orig; /**< @brief cutoff radius (rcut) original value given at command line. */
68     const char *rcut_help; /**< @brief cutoff radius (rcut) help description. */
69 gezelter 1454 double dz_arg; /**< @brief slab width (dz). */
70     char * dz_orig; /**< @brief slab width (dz) original value given at command line. */
71     const char *dz_help; /**< @brief slab width (dz) help description. */
72 gezelter 1390 double length_arg; /**< @brief maximum length (Defaults to 1/2 smallest length of first frame). */
73     char * length_orig; /**< @brief maximum length (Defaults to 1/2 smallest length of first frame) original value given at command line. */
74     const char *length_help; /**< @brief maximum length (Defaults to 1/2 smallest length of first frame) help description. */
75 chuckv 1445 double zlength_arg; /**< @brief maximum length (Defaults to 1/2 smallest length of first frame). */
76     char * zlength_orig; /**< @brief maximum length (Defaults to 1/2 smallest length of first frame) original value given at command line. */
77     const char *zlength_help; /**< @brief maximum length (Defaults to 1/2 smallest length of first frame) help description. */
78 gezelter 1390 double zoffset_arg; /**< @brief Where to set the zero for the slab_density calculation (default='0'). */
79     char * zoffset_orig; /**< @brief Where to set the zero for the slab_density calculation original value given at command line. */
80     const char *zoffset_help; /**< @brief Where to set the zero for the slab_density calculation help description. */
81     char * sele1_arg; /**< @brief select the first stuntdouble set. */
82     char * sele1_orig; /**< @brief select the first stuntdouble set original value given at command line. */
83     const char *sele1_help; /**< @brief select the first stuntdouble set help description. */
84     char * sele2_arg; /**< @brief select the second stuntdouble set. */
85     char * sele2_orig; /**< @brief select the second stuntdouble set original value given at command line. */
86     const char *sele2_help; /**< @brief select the second stuntdouble set help description. */
87     char * sele3_arg; /**< @brief select the third stuntdouble set. */
88     char * sele3_orig; /**< @brief select the third stuntdouble set original value given at command line. */
89     const char *sele3_help; /**< @brief select the third stuntdouble set help description. */
90     char * refsele_arg; /**< @brief select reference (use and only use with --gxyz). */
91     char * refsele_orig; /**< @brief select reference (use and only use with --gxyz) original value given at command line. */
92     const char *refsele_help; /**< @brief select reference (use and only use with --gxyz) help description. */
93     char * comsele_arg; /**< @brief select stunt doubles for center-of-mass reference point. */
94     char * comsele_orig; /**< @brief select stunt doubles for center-of-mass reference point original value given at command line. */
95     const char *comsele_help; /**< @brief select stunt doubles for center-of-mass reference point help description. */
96     char * molname_arg; /**< @brief molecule name. */
97     char * molname_orig; /**< @brief molecule name original value given at command line. */
98     const char *molname_help; /**< @brief molecule name help description. */
99     int begin_arg; /**< @brief begin internal index. */
100     char * begin_orig; /**< @brief begin internal index original value given at command line. */
101     const char *begin_help; /**< @brief begin internal index help description. */
102     int end_arg; /**< @brief end internal index. */
103     char * end_orig; /**< @brief end internal index original value given at command line. */
104     const char *end_help; /**< @brief end internal index help description. */
105     double radius_arg; /**< @brief nanoparticle radius. */
106     char * radius_orig; /**< @brief nanoparticle radius original value given at command line. */
107     const char *radius_help; /**< @brief nanoparticle radius help description. */
108     const char *bo_help; /**< @brief bond order parameter (--rcut must be specified) help description. */
109     const char *bor_help; /**< @brief bond order parameter as a function of radius (--rcut must be specified) help description. */
110     const char *bad_help; /**< @brief N(theta) bond angle density within (--rcut must be specified) help description. */
111 gezelter 1513 const char *count_help; /**< @brief count of molecules matching selection criteria (and associated statistics) help description. */
112 gezelter 1390 const char *gofr_help; /**< @brief g(r) help description. */
113     const char *gofz_help; /**< @brief g(z) help description. */
114     const char *r_theta_help; /**< @brief g(r, cos(theta)) help description. */
115     const char *r_omega_help; /**< @brief g(r, cos(omega)) help description. */
116 gezelter 1440 const char *r_z_help; /**< @brief g(r, z) help description. */
117 gezelter 1390 const char *theta_omega_help; /**< @brief g(cos(theta), cos(omega)) help description. */
118     const char *gxyz_help; /**< @brief g(x, y, z) help description. */
119 gezelter 1454 const char *twodgofr_help; /**< @brief 2D g(r) (Slab width --dz must be specified) help description. */
120 gezelter 1542 const char *p2_help; /**< @brief p2 order parameter (--sele1 must be specified, --sele2 is optional) help description. */
121 gezelter 1390 const char *rp2_help; /**< @brief rp2 order parameter (--sele1 and --sele2 must be specified) help description. */
122     const char *scd_help; /**< @brief scd order parameter (either --sele1, --sele2, --sele3 are specified or --molname, --begin, --end are specified) help description. */
123     const char *density_help; /**< @brief density plot help description. */
124     const char *slab_density_help; /**< @brief slab density help description. */
125 gezelter 1413 const char *p_angle_help; /**< @brief p(cos(theta)) help description. */
126 gezelter 1390 const char *hxy_help; /**< @brief hxy help description. */
127     const char *rho_r_help; /**< @brief rho of R help description. */
128 kstocke1 1522 const char *angle_r_help; /**< @brief angle of R help description. */
129 gezelter 1390 const char *hullvol_help; /**< @brief hull volume of nanoparticle help description. */
130 gezelter 1585 const char *rodlength_help; /**< @brief length of nanorod help description. */
131 kstocke1 1522 const char *tet_param_help; /**< @brief tetrahedrality order parameter help description. */
132 gezelter 1782 const char *tet_param_z_help; /**< @brief tetrahedrality order parameter by zbin(--sele1 must be specified) help description. */
133 gezelter 929
134 gezelter 1390 unsigned int help_given ; /**< @brief Whether help was given. */
135     unsigned int version_given ; /**< @brief Whether version was given. */
136     unsigned int input_given ; /**< @brief Whether input was given. */
137     unsigned int output_given ; /**< @brief Whether output was given. */
138     unsigned int step_given ; /**< @brief Whether step was given. */
139     unsigned int nbins_given ; /**< @brief Whether nbins was given. */
140     unsigned int nbins_x_given ; /**< @brief Whether nbins_x was given. */
141     unsigned int nbins_y_given ; /**< @brief Whether nbins_y was given. */
142 gezelter 1440 unsigned int nbins_z_given ; /**< @brief Whether nbins_z was given. */
143 gezelter 1390 unsigned int nanglebins_given ; /**< @brief Whether nanglebins was given. */
144 chuckv 1445 unsigned int rcut_given ; /**< @brief Whether rcut was given. */
145 gezelter 1454 unsigned int dz_given ; /**< @brief Whether dz was given. */
146 gezelter 1390 unsigned int length_given ; /**< @brief Whether length was given. */
147 chuckv 1445 unsigned int zlength_given ; /**< @brief Whether zlength was given. */
148 gezelter 1390 unsigned int zoffset_given ; /**< @brief Whether zoffset was given. */
149     unsigned int sele1_given ; /**< @brief Whether sele1 was given. */
150     unsigned int sele2_given ; /**< @brief Whether sele2 was given. */
151     unsigned int sele3_given ; /**< @brief Whether sele3 was given. */
152     unsigned int refsele_given ; /**< @brief Whether refsele was given. */
153     unsigned int comsele_given ; /**< @brief Whether comsele was given. */
154     unsigned int molname_given ; /**< @brief Whether molname was given. */
155     unsigned int begin_given ; /**< @brief Whether begin was given. */
156     unsigned int end_given ; /**< @brief Whether end was given. */
157     unsigned int radius_given ; /**< @brief Whether radius was given. */
158     unsigned int bo_given ; /**< @brief Whether bo was given. */
159     unsigned int bor_given ; /**< @brief Whether bor was given. */
160     unsigned int bad_given ; /**< @brief Whether bad was given. */
161 gezelter 1513 unsigned int count_given ; /**< @brief Whether count was given. */
162 gezelter 1390 unsigned int gofr_given ; /**< @brief Whether gofr was given. */
163     unsigned int gofz_given ; /**< @brief Whether gofz was given. */
164     unsigned int r_theta_given ; /**< @brief Whether r_theta was given. */
165     unsigned int r_omega_given ; /**< @brief Whether r_omega was given. */
166 gezelter 1440 unsigned int r_z_given ; /**< @brief Whether r_z was given. */
167 gezelter 1390 unsigned int theta_omega_given ; /**< @brief Whether theta_omega was given. */
168     unsigned int gxyz_given ; /**< @brief Whether gxyz was given. */
169 gezelter 1454 unsigned int twodgofr_given ; /**< @brief Whether twodgofr was given. */
170 gezelter 1390 unsigned int p2_given ; /**< @brief Whether p2 was given. */
171     unsigned int rp2_given ; /**< @brief Whether rp2 was given. */
172     unsigned int scd_given ; /**< @brief Whether scd was given. */
173     unsigned int density_given ; /**< @brief Whether density was given. */
174     unsigned int slab_density_given ; /**< @brief Whether slab_density was given. */
175 gezelter 1413 unsigned int p_angle_given ; /**< @brief Whether p_angle was given. */
176 gezelter 1390 unsigned int hxy_given ; /**< @brief Whether hxy was given. */
177     unsigned int rho_r_given ; /**< @brief Whether rho_r was given. */
178 kstocke1 1522 unsigned int angle_r_given ; /**< @brief Whether angle_r was given. */
179 gezelter 1390 unsigned int hullvol_given ; /**< @brief Whether hullvol was given. */
180 gezelter 1585 unsigned int rodlength_given ; /**< @brief Whether rodlength was given. */
181 kstocke1 1522 unsigned int tet_param_given ; /**< @brief Whether tet_param was given. */
182 gezelter 1782 unsigned int tet_param_z_given ; /**< @brief Whether tet_param_z was given. */
183 tim 310
184 gezelter 1454 char **inputs ; /**< @brief unamed options (options without names) */
185     unsigned inputs_num ; /**< @brief unamed options number */
186 gezelter 1390 int staticProps_group_counter; /**< @brief Counter for group staticProps */
187 tim 543 } ;
188 tim 310
189 gezelter 1390 /** @brief The additional parameters to pass to parser functions */
190     struct cmdline_parser_params
191     {
192     int override; /**< @brief whether to override possibly already present options (default 0) */
193     int initialize; /**< @brief whether to initialize the option structure gengetopt_args_info (default 1) */
194     int check_required; /**< @brief whether to check that all required options were provided (default 1) */
195     int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */
196     int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
197     } ;
198    
199     /** @brief the purpose string of the program */
200 chuckv 1128 extern const char *gengetopt_args_info_purpose;
201 gezelter 1390 /** @brief the usage string of the program */
202 chuckv 1128 extern const char *gengetopt_args_info_usage;
203 gezelter 1390 /** @brief all the lines making the help output */
204 chuckv 1128 extern const char *gengetopt_args_info_help[];
205 tim 310
206 gezelter 1390 /**
207     * The command line parser
208     * @param argc the number of command line options
209     * @param argv the command line options
210     * @param args_info the structure where option information will be stored
211     * @return 0 if everything went fine, NON 0 if an error took place
212     */
213 kstocke1 1531 int cmdline_parser (int argc, char **argv,
214 chuckv 1128 struct gengetopt_args_info *args_info);
215 gezelter 1390
216     /**
217     * The command line parser (version with additional parameters - deprecated)
218     * @param argc the number of command line options
219     * @param argv the command line options
220     * @param args_info the structure where option information will be stored
221     * @param override whether to override possibly already present options
222     * @param initialize whether to initialize the option structure my_args_info
223     * @param check_required whether to check that all required options were provided
224     * @return 0 if everything went fine, NON 0 if an error took place
225     * @deprecated use cmdline_parser_ext() instead
226     */
227 kstocke1 1531 int cmdline_parser2 (int argc, char **argv,
228 chuckv 1128 struct gengetopt_args_info *args_info,
229     int override, int initialize, int check_required);
230 gezelter 1390
231     /**
232     * The command line parser (version with additional parameters)
233     * @param argc the number of command line options
234     * @param argv the command line options
235     * @param args_info the structure where option information will be stored
236     * @param params additional parameters for the parser
237     * @return 0 if everything went fine, NON 0 if an error took place
238     */
239 kstocke1 1531 int cmdline_parser_ext (int argc, char **argv,
240 gezelter 1390 struct gengetopt_args_info *args_info,
241     struct cmdline_parser_params *params);
242    
243     /**
244     * Save the contents of the option struct into an already open FILE stream.
245     * @param outfile the stream where to dump options
246     * @param args_info the option struct to dump
247     * @return 0 if everything went fine, NON 0 if an error took place
248     */
249     int cmdline_parser_dump(FILE *outfile,
250     struct gengetopt_args_info *args_info);
251    
252     /**
253     * Save the contents of the option struct into a (text) file.
254     * This file can be read by the config file parser (if generated by gengetopt)
255     * @param filename the file where to save
256     * @param args_info the option struct to save
257     * @return 0 if everything went fine, NON 0 if an error took place
258     */
259 chuckv 1128 int cmdline_parser_file_save(const char *filename,
260     struct gengetopt_args_info *args_info);
261    
262 gezelter 1390 /**
263     * Print the help
264     */
265 tim 543 void cmdline_parser_print_help(void);
266 gezelter 1390 /**
267     * Print the version
268     */
269 tim 543 void cmdline_parser_print_version(void);
270 tim 310
271 gezelter 1390 /**
272     * Initializes all the fields a cmdline_parser_params structure
273     * to their default values
274     * @param params the structure to initialize
275     */
276     void cmdline_parser_params_init(struct cmdline_parser_params *params);
277    
278     /**
279     * Allocates dynamically a cmdline_parser_params structure and initializes
280     * all its fields to their default values
281     * @return the created and initialized cmdline_parser_params structure
282     */
283     struct cmdline_parser_params *cmdline_parser_params_create(void);
284    
285     /**
286     * Initializes the passed gengetopt_args_info structure's fields
287     * (also set default values for options that have a default)
288     * @param args_info the structure to initialize
289     */
290 gezelter 929 void cmdline_parser_init (struct gengetopt_args_info *args_info);
291 gezelter 1390 /**
292     * Deallocates the string fields of the gengetopt_args_info structure
293     * (but does not deallocate the structure itself)
294     * @param args_info the structure to deallocate
295     */
296 gezelter 929 void cmdline_parser_free (struct gengetopt_args_info *args_info);
297    
298 gezelter 1390 /**
299     * Checks that all the required options were specified
300     * @param args_info the structure to check
301     * @param prog_name the name of the program that will be used to print
302     * possible errors
303     * @return
304     */
305 chuckv 1128 int cmdline_parser_required (struct gengetopt_args_info *args_info,
306     const char *prog_name);
307 gezelter 929
308    
309 tim 310 #ifdef __cplusplus
310     }
311     #endif /* __cplusplus */
312     #endif /* STATICPROPSCMD_H */

Properties

Name Value
svn:keywords Author Id Revision Date