ViewVC Help

View File | Revision Log | Show Annotations | View Changeset | Root Listing

root/OpenMD/trunk/src/applications/staticProps/StaticPropsCmd.h

Comparing trunk/src/applications/staticProps/StaticPropsCmd.h (file contents):
Revision 840 by tim, Mon Jan 9 22:14:32 2006 UTC vs.
Revision 1843 by gezelter, Tue Jan 29 20:58:08 2013 UTC

#	Line 1 | Line 1
1	<	/* StaticPropsCmd.h */
1	>	/** @file StaticPropsCmd.h
2	>	*  @brief The header file for the command line option parser
3	>	*  generated by GNU Gengetopt version 2.22.4
4	>	*  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
3	–	/* File autogenerated by gengetopt version 2.11  */
4	–
8		#ifndef STATICPROPSCMD_H
9		#define STATICPROPSCMD_H
10
#	Line 10 | Line 13
13		#include "config.h"
14		#endif
15
16	+	#include <stdio.h> /* for FILE */
17	+
18		#ifdef __cplusplus
19		extern "C" {
20		#endif /* __cplusplus */
21
22		#ifndef CMDLINE_PARSER_PACKAGE
23	+	/** @brief the program name (used for printing errors) */
24		#define CMDLINE_PARSER_PACKAGE "StaticProps"
25		#endif
26
27	+	#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		#ifndef CMDLINE_PARSER_VERSION
33	+	/** @brief the program version */
34		#define CMDLINE_PARSER_VERSION "1.00"
35		#endif
36
37	+	/** @brief Where the command line options are stored */
38		struct gengetopt_args_info
39		{
40	<	char * input_arg;     /* input dump file.  */
41	<	char * output_arg;    /* output file name.  */
42	<	int step_arg; /* process every n frame (default='1').  */
43	<	int nrbins_arg;       /* number of bins for distance (default='100').  */
44	<	int nanglebins_arg;   /* number of bins for cos(angle) (default='50').  */
45	<	double length_arg;    /* maximum length (Defaults to 1/2 smallest length of first frame).  */
46	<	char * sele1_arg;     /* select the first stuntdouble set.  */
47	<	char * sele2_arg;     /* select the second stuntdouble set.  */
48	<	char * sele3_arg;     /* select the third stuntdouble set.  */
49	<	char * refsele_arg;   /* select reference (use and only use with --gxyz).  */
50	<	char * molname_arg;   /* molecule name.  */
51	<	int begin_arg;        /* begin interanl index.  */
52	<	int end_arg;  /* end internal index.  */
40	>	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	>	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	>	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	>	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	>	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	>	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	>	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	>	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	>	int seleoffset_arg;   /**< @brief global index offset for a second object (used to define a vector between sites in molecule).  */
97	>	char * seleoffset_orig;       /**< @brief global index offset for a second object (used to define a vector between sites in molecule) original value given at command line.  */
98	>	const char *seleoffset_help; /**< @brief global index offset for a second object (used to define a vector between sites in molecule) help description.  */
99	>	char * molname_arg;   /**< @brief molecule name.  */
100	>	char * molname_orig;  /**< @brief molecule name original value given at command line.  */
101	>	const char *molname_help; /**< @brief molecule name help description.  */
102	>	int begin_arg;        /**< @brief begin internal index.  */
103	>	char * begin_orig;    /**< @brief begin internal index original value given at command line.  */
104	>	const char *begin_help; /**< @brief begin internal index help description.  */
105	>	int end_arg;  /**< @brief end internal index.  */
106	>	char * end_orig;      /**< @brief end internal index original value given at command line.  */
107	>	const char *end_help; /**< @brief end internal index help description.  */
108	>	double radius_arg;    /**< @brief nanoparticle radius.  */
109	>	char * radius_orig;   /**< @brief nanoparticle radius original value given at command line.  */
110	>	const char *radius_help; /**< @brief nanoparticle radius help description.  */
111	>	const char *bo_help; /**< @brief bond order parameter (--rcut must be specified) help description.  */
112	>	const char *bor_help; /**< @brief bond order parameter as a function of radius (--rcut must be specified) help description.  */
113	>	const char *bad_help; /**< @brief N(theta) bond angle density within (--rcut must be specified) help description.  */
114	>	const char *count_help; /**< @brief count of molecules matching selection criteria (and associated statistics) help description.  */
115	>	const char *gofr_help; /**< @brief g(r) help description.  */
116	>	const char *gofz_help; /**< @brief g(z) help description.  */
117	>	const char *r_theta_help; /**< @brief g(r, cos(theta)) help description.  */
118	>	const char *r_omega_help; /**< @brief g(r, cos(omega)) help description.  */
119	>	const char *r_z_help; /**< @brief g(r, z) help description.  */
120	>	const char *theta_omega_help; /**< @brief g(cos(theta), cos(omega)) help description.  */
121	>	const char *gxyz_help; /**< @brief g(x, y, z) help description.  */
122	>	const char *twodgofr_help; /**< @brief 2D g(r) (Slab width --dz must be specified) help description.  */
123	>	const char *p2_help; /**< @brief p2 order parameter (--sele1 must be specified, --sele2 is optional) help description.  */
124	>	const char *rp2_help; /**< @brief rp2 order parameter (--sele1 and --sele2 must be specified) help description.  */
125	>	const char *scd_help; /**< @brief scd order parameter (either --sele1, --sele2, --sele3 are specified or --molname, --begin, --end are specified) help description.  */
126	>	const char *density_help; /**< @brief density plot help description.  */
127	>	const char *slab_density_help; /**< @brief slab density help description.  */
128	>	const char *p_angle_help; /**< @brief p(cos(theta)) help description.  */
129	>	const char *hxy_help; /**< @brief hxy help description.  */
130	>	const char *rho_r_help; /**< @brief rho of R help description.  */
131	>	const char *angle_r_help; /**< @brief angle of R help description.  */
132	>	const char *hullvol_help; /**< @brief hull volume of nanoparticle help description.  */
133	>	const char *rodlength_help; /**< @brief length of nanorod help description.  */
134	>	const char *tet_param_help; /**< @brief tetrahedrality order parameter (Qk) help description.  */
135	>	const char *tet_param_z_help; /**< @brief spatially-resolved tetrahedrality order parameter Qk(z) help description.  */
136	>
137	>	unsigned int help_given ;     /**< @brief Whether help was given.  */
138	>	unsigned int version_given ;  /**< @brief Whether version was given.  */
139	>	unsigned int input_given ;    /**< @brief Whether input was given.  */
140	>	unsigned int output_given ;   /**< @brief Whether output was given.  */
141	>	unsigned int step_given ;     /**< @brief Whether step was given.  */
142	>	unsigned int nbins_given ;    /**< @brief Whether nbins was given.  */
143	>	unsigned int nbins_x_given ;  /**< @brief Whether nbins_x was given.  */
144	>	unsigned int nbins_y_given ;  /**< @brief Whether nbins_y was given.  */
145	>	unsigned int nbins_z_given ;  /**< @brief Whether nbins_z was given.  */
146	>	unsigned int nanglebins_given ;       /**< @brief Whether nanglebins was given.  */
147	>	unsigned int rcut_given ;     /**< @brief Whether rcut was given.  */
148	>	unsigned int dz_given ;       /**< @brief Whether dz was given.  */
149	>	unsigned int length_given ;   /**< @brief Whether length was given.  */
150	>	unsigned int zlength_given ;  /**< @brief Whether zlength was given.  */
151	>	unsigned int zoffset_given ;  /**< @brief Whether zoffset was given.  */
152	>	unsigned int sele1_given ;    /**< @brief Whether sele1 was given.  */
153	>	unsigned int sele2_given ;    /**< @brief Whether sele2 was given.  */
154	>	unsigned int sele3_given ;    /**< @brief Whether sele3 was given.  */
155	>	unsigned int refsele_given ;  /**< @brief Whether refsele was given.  */
156	>	unsigned int comsele_given ;  /**< @brief Whether comsele was given.  */
157	>	unsigned int seleoffset_given ;       /**< @brief Whether seleoffset was given.  */
158	>	unsigned int molname_given ;  /**< @brief Whether molname was given.  */
159	>	unsigned int begin_given ;    /**< @brief Whether begin was given.  */
160	>	unsigned int end_given ;      /**< @brief Whether end was given.  */
161	>	unsigned int radius_given ;   /**< @brief Whether radius was given.  */
162	>	unsigned int bo_given ;       /**< @brief Whether bo was given.  */
163	>	unsigned int bor_given ;      /**< @brief Whether bor was given.  */
164	>	unsigned int bad_given ;      /**< @brief Whether bad was given.  */
165	>	unsigned int count_given ;    /**< @brief Whether count was given.  */
166	>	unsigned int gofr_given ;     /**< @brief Whether gofr was given.  */
167	>	unsigned int gofz_given ;     /**< @brief Whether gofz was given.  */
168	>	unsigned int r_theta_given ;  /**< @brief Whether r_theta was given.  */
169	>	unsigned int r_omega_given ;  /**< @brief Whether r_omega was given.  */
170	>	unsigned int r_z_given ;      /**< @brief Whether r_z was given.  */
171	>	unsigned int theta_omega_given ;      /**< @brief Whether theta_omega was given.  */
172	>	unsigned int gxyz_given ;     /**< @brief Whether gxyz was given.  */
173	>	unsigned int twodgofr_given ; /**< @brief Whether twodgofr was given.  */
174	>	unsigned int p2_given ;       /**< @brief Whether p2 was given.  */
175	>	unsigned int rp2_given ;      /**< @brief Whether rp2 was given.  */
176	>	unsigned int scd_given ;      /**< @brief Whether scd was given.  */
177	>	unsigned int density_given ;  /**< @brief Whether density was given.  */
178	>	unsigned int slab_density_given ;     /**< @brief Whether slab_density was given.  */
179	>	unsigned int p_angle_given ;  /**< @brief Whether p_angle was given.  */
180	>	unsigned int hxy_given ;      /**< @brief Whether hxy was given.  */
181	>	unsigned int rho_r_given ;    /**< @brief Whether rho_r was given.  */
182	>	unsigned int angle_r_given ;  /**< @brief Whether angle_r was given.  */
183	>	unsigned int hullvol_given ;  /**< @brief Whether hullvol was given.  */
184	>	unsigned int rodlength_given ;        /**< @brief Whether rodlength was given.  */
185	>	unsigned int tet_param_given ;        /**< @brief Whether tet_param was given.  */
186	>	unsigned int tet_param_z_given ;      /**< @brief Whether tet_param_z was given.  */
187
188	<	int help_given ;      /* Whether help was given.  */
189	<	int version_given ;   /* Whether version was given.  */
190	<	int input_given ;     /* Whether input was given.  */
191	<	int output_given ;    /* Whether output was given.  */
45	<	int step_given ;      /* Whether step was given.  */
46	<	int nrbins_given ;    /* Whether nrbins was given.  */
47	<	int nanglebins_given ;        /* Whether nanglebins was given.  */
48	<	int length_given ;    /* Whether length was given.  */
49	<	int sele1_given ;     /* Whether sele1 was given.  */
50	<	int sele2_given ;     /* Whether sele2 was given.  */
51	<	int sele3_given ;     /* Whether sele3 was given.  */
52	<	int refsele_given ;   /* Whether refsele was given.  */
53	<	int molname_given ;   /* Whether molname was given.  */
54	<	int begin_given ;     /* Whether begin was given.  */
55	<	int end_given ;       /* Whether end was given.  */
56	<	int gofr_given ;      /* Whether gofr was given.  */
57	<	int r_theta_given ;   /* Whether r_theta was given.  */
58	<	int r_omega_given ;   /* Whether r_omega was given.  */
59	<	int theta_omega_given ;       /* Whether theta_omega was given.  */
60	<	int gxyz_given ;      /* Whether gxyz was given.  */
61	<	int p2_given ;        /* Whether p2 was given.  */
62	<	int scd_given ;       /* Whether scd was given.  */
63	<	int density_given ;   /* Whether density was given.  */
64	<	int slab_density_given ;      /* Whether slab_density was given.  */
188	>	char **inputs ; /**< @brief unamed options (options without names) */
189	>	unsigned inputs_num ; /**< @brief unamed options number */
190	>	int staticProps_group_counter; /**< @brief Counter for group staticProps */
191	>	} ;
192
193	+	/** @brief The additional parameters to pass to parser functions */
194	+	struct cmdline_parser_params
195	+	{
196	+	int override; /**< @brief whether to override possibly already present options (default 0) */
197	+	int initialize; /**< @brief whether to initialize the option structure gengetopt_args_info (default 1) */
198	+	int check_required; /**< @brief whether to check that all required options were provided (default 1) */
199	+	int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */
200	+	int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
201		} ;
202
203	<	int cmdline_parser (int argc, char * const *argv, struct gengetopt_args_info *args_info);
203	>	/** @brief the purpose string of the program */
204	>	extern const char *gengetopt_args_info_purpose;
205	>	/** @brief the usage string of the program */
206	>	extern const char *gengetopt_args_info_usage;
207	>	/** @brief all the lines making the help output */
208	>	extern const char *gengetopt_args_info_help[];
209
210	+	/**
211	+	* The command line parser
212	+	* @param argc the number of command line options
213	+	* @param argv the command line options
214	+	* @param args_info the structure where option information will be stored
215	+	* @return 0 if everything went fine, NON 0 if an error took place
216	+	*/
217	+	int cmdline_parser (int argc, char **argv,
218	+	struct gengetopt_args_info *args_info);
219	+
220	+	/**
221	+	* The command line parser (version with additional parameters - deprecated)
222	+	* @param argc the number of command line options
223	+	* @param argv the command line options
224	+	* @param args_info the structure where option information will be stored
225	+	* @param override whether to override possibly already present options
226	+	* @param initialize whether to initialize the option structure my_args_info
227	+	* @param check_required whether to check that all required options were provided
228	+	* @return 0 if everything went fine, NON 0 if an error took place
229	+	* @deprecated use cmdline_parser_ext() instead
230	+	*/
231	+	int cmdline_parser2 (int argc, char **argv,
232	+	struct gengetopt_args_info *args_info,
233	+	int override, int initialize, int check_required);
234	+
235	+	/**
236	+	* The command line parser (version with additional parameters)
237	+	* @param argc the number of command line options
238	+	* @param argv the command line options
239	+	* @param args_info the structure where option information will be stored
240	+	* @param params additional parameters for the parser
241	+	* @return 0 if everything went fine, NON 0 if an error took place
242	+	*/
243	+	int cmdline_parser_ext (int argc, char **argv,
244	+	struct gengetopt_args_info *args_info,
245	+	struct cmdline_parser_params *params);
246	+
247	+	/**
248	+	* Save the contents of the option struct into an already open FILE stream.
249	+	* @param outfile the stream where to dump options
250	+	* @param args_info the option struct to dump
251	+	* @return 0 if everything went fine, NON 0 if an error took place
252	+	*/
253	+	int cmdline_parser_dump(FILE *outfile,
254	+	struct gengetopt_args_info *args_info);
255	+
256	+	/**
257	+	* Save the contents of the option struct into a (text) file.
258	+	* This file can be read by the config file parser (if generated by gengetopt)
259	+	* @param filename the file where to save
260	+	* @param args_info the option struct to save
261	+	* @return 0 if everything went fine, NON 0 if an error took place
262	+	*/
263	+	int cmdline_parser_file_save(const char *filename,
264	+	struct gengetopt_args_info *args_info);
265	+
266	+	/**
267	+	* Print the help
268	+	*/
269		void cmdline_parser_print_help(void);
270	+	/**
271	+	* Print the version
272	+	*/
273		void cmdline_parser_print_version(void);
274
275	+	/**
276	+	* Initializes all the fields a cmdline_parser_params structure
277	+	* to their default values
278	+	* @param params the structure to initialize
279	+	*/
280	+	void cmdline_parser_params_init(struct cmdline_parser_params *params);
281	+
282	+	/**
283	+	* Allocates dynamically a cmdline_parser_params structure and initializes
284	+	* all its fields to their default values
285	+	* @return the created and initialized cmdline_parser_params structure
286	+	*/
287	+	struct cmdline_parser_params *cmdline_parser_params_create(void);
288	+
289	+	/**
290	+	* Initializes the passed gengetopt_args_info structure's fields
291	+	* (also set default values for options that have a default)
292	+	* @param args_info the structure to initialize
293	+	*/
294	+	void cmdline_parser_init (struct gengetopt_args_info *args_info);
295	+	/**
296	+	* Deallocates the string fields of the gengetopt_args_info structure
297	+	* (but does not deallocate the structure itself)
298	+	* @param args_info the structure to deallocate
299	+	*/
300	+	void cmdline_parser_free (struct gengetopt_args_info *args_info);
301	+
302	+	/**
303	+	* Checks that all the required options were specified
304	+	* @param args_info the structure to check
305	+	* @param prog_name the name of the program that will be used to print
306	+	*   possible errors
307	+	* @return
308	+	*/
309	+	int cmdline_parser_required (struct gengetopt_args_info *args_info,
310	+	const char *prog_name);
311	+
312	+
313		#ifdef __cplusplus
314		}
315		#endif /* __cplusplus */

Comparing trunk/src/applications/staticProps/StaticPropsCmd.h (property svn:keywords):
Revision 840 by tim, Mon Jan 9 22:14:32 2006 UTC vs.
Revision 1843 by gezelter, Tue Jan 29 20:58:08 2013 UTC

#	Line 0 | Line 1
1	+	Author Id Revision Date

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines