ViewVC Help

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

root/OpenMD/trunk/src/applications/dynamicProps/DynamicPropsCmd.h

Comparing trunk/src/applications/dynamicProps/DynamicPropsCmd.h (file contents):
Revision 876 by tim, Mon Jan 30 22:25:27 2006 UTC vs.
Revision 1811 by gezelter, Fri Nov 16 15:12:21 2012 UTC

#	Line 1 | Line 1
1	<	/* DynamicPropsCmd.h */
1	>	/** @file DynamicPropsCmd.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 DYNAMICPROPSCMD_H
9		#define DYNAMICPROPSCMD_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 "DynamicProps"
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 "DynamicProps"
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	<	char * sele1_arg;     /* select first stuntdouble set.  */
43	<	char * sele2_arg;     /* select second stuntdouble set (if sele2 is not set, use script from sele1).  */
44	<	int order_arg;        /* Lengendre Polynomial Order.  */
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	>	char * sele1_arg;     /**< @brief select first stuntdouble set.  */
49	>	char * sele1_orig;    /**< @brief select first stuntdouble set original value given at command line.  */
50	>	const char *sele1_help; /**< @brief select first stuntdouble set help description.  */
51	>	char * sele2_arg;     /**< @brief select second stuntdouble set (if sele2 is not set, use script from sele1).  */
52	>	char * sele2_orig;    /**< @brief select second stuntdouble set (if sele2 is not set, use script from sele1) original value given at command line.  */
53	>	const char *sele2_help; /**< @brief select second stuntdouble set (if sele2 is not set, use script from sele1) help description.  */
54	>	int order_arg;        /**< @brief Lengendre Polynomial Order.  */
55	>	char * order_orig;    /**< @brief Lengendre Polynomial Order original value given at command line.  */
56	>	const char *order_help; /**< @brief Lengendre Polynomial Order help description.  */
57	>	char * memory_arg;    /**< @brief Available memory (defaults to 2G) (default='2G').  */
58	>	char * memory_orig;   /**< @brief Available memory (defaults to 2G) original value given at command line.  */
59	>	const char *memory_help; /**< @brief Available memory (defaults to 2G) help description.  */
60	>	const char *selecorr_help; /**< @brief selection correlation function help description.  */
61	>	const char *rcorr_help; /**< @brief rmsd help description.  */
62	>	const char *vcorr_help; /**< @brief velocity correlation function help description.  */
63	>	const char *dcorr_help; /**< @brief dipole correlation function help description.  */
64	>	const char *lcorr_help; /**< @brief Lengendre correlation function help description.  */
65	>	const char *sdcorr_help; /**< @brief System dipole correlation function help description.  */
66	>	const char *r_rcorr_help; /**< @brief Radial rmsd help description.  */
67	>	const char *thetacorr_help; /**< @brief Angular rmsd help description.  */
68	>	const char *drcorr_help; /**< @brief Directional rmsd for particles with unit vectors help description.  */
69	>	const char *helfandEcorr_help; /**< @brief Helfand moment for thermal conductvity help description.  */
70	>	const char *momentum_help; /**< @brief Helfand momentum for viscosity help description.  */
71	>	const char *stresscorr_help; /**< @brief Stress tensor correlation function help description.  */
72	>
73	>	unsigned int help_given ;     /**< @brief Whether help was given.  */
74	>	unsigned int version_given ;  /**< @brief Whether version was given.  */
75	>	unsigned int input_given ;    /**< @brief Whether input was given.  */
76	>	unsigned int output_given ;   /**< @brief Whether output was given.  */
77	>	unsigned int sele1_given ;    /**< @brief Whether sele1 was given.  */
78	>	unsigned int sele2_given ;    /**< @brief Whether sele2 was given.  */
79	>	unsigned int order_given ;    /**< @brief Whether order was given.  */
80	>	unsigned int memory_given ;   /**< @brief Whether memory was given.  */
81	>	unsigned int selecorr_given ; /**< @brief Whether selecorr was given.  */
82	>	unsigned int rcorr_given ;    /**< @brief Whether rcorr was given.  */
83	>	unsigned int vcorr_given ;    /**< @brief Whether vcorr was given.  */
84	>	unsigned int dcorr_given ;    /**< @brief Whether dcorr was given.  */
85	>	unsigned int lcorr_given ;    /**< @brief Whether lcorr was given.  */
86	>	unsigned int sdcorr_given ;   /**< @brief Whether sdcorr was given.  */
87	>	unsigned int r_rcorr_given ;  /**< @brief Whether r_rcorr was given.  */
88	>	unsigned int thetacorr_given ;        /**< @brief Whether thetacorr was given.  */
89	>	unsigned int drcorr_given ;   /**< @brief Whether drcorr was given.  */
90	>	unsigned int helfandEcorr_given ;     /**< @brief Whether helfandEcorr was given.  */
91	>	unsigned int momentum_given ; /**< @brief Whether momentum was given.  */
92	>	unsigned int stresscorr_given ;       /**< @brief Whether stresscorr was given.  */
93
94	<	int help_given ;      /* Whether help was given.  */
95	<	int version_given ;   /* Whether version was given.  */
96	<	int input_given ;     /* Whether input was given.  */
97	<	int output_given ;    /* Whether output was given.  */
37	<	int sele1_given ;     /* Whether sele1 was given.  */
38	<	int sele2_given ;     /* Whether sele2 was given.  */
39	<	int order_given ;     /* Whether order was given.  */
40	<	int rcorr_given ;     /* Whether rcorr was given.  */
41	<	int vcorr_given ;     /* Whether vcorr was given.  */
42	<	int dcorr_given ;     /* Whether dcorr was given.  */
43	<	int lcorr_given ;     /* Whether lcorr was given.  */
94	>	char **inputs ; /**< @brief unamed options (options without names) */
95	>	unsigned inputs_num ; /**< @brief unamed options number */
96	>	int dynamicProps_group_counter; /**< @brief Counter for group dynamicProps */
97	>	} ;
98
99	+	/** @brief The additional parameters to pass to parser functions */
100	+	struct cmdline_parser_params
101	+	{
102	+	int override; /**< @brief whether to override possibly already present options (default 0) */
103	+	int initialize; /**< @brief whether to initialize the option structure gengetopt_args_info (default 1) */
104	+	int check_required; /**< @brief whether to check that all required options were provided (default 1) */
105	+	int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */
106	+	int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
107		} ;
108
109	<	int cmdline_parser (int argc, char * const *argv, struct gengetopt_args_info *args_info);
109	>	/** @brief the purpose string of the program */
110	>	extern const char *gengetopt_args_info_purpose;
111	>	/** @brief the usage string of the program */
112	>	extern const char *gengetopt_args_info_usage;
113	>	/** @brief all the lines making the help output */
114	>	extern const char *gengetopt_args_info_help[];
115
116	+	/**
117	+	* The command line parser
118	+	* @param argc the number of command line options
119	+	* @param argv the command line options
120	+	* @param args_info the structure where option information will be stored
121	+	* @return 0 if everything went fine, NON 0 if an error took place
122	+	*/
123	+	int cmdline_parser (int argc, char **argv,
124	+	struct gengetopt_args_info *args_info);
125	+
126	+	/**
127	+	* The command line parser (version with additional parameters - deprecated)
128	+	* @param argc the number of command line options
129	+	* @param argv the command line options
130	+	* @param args_info the structure where option information will be stored
131	+	* @param override whether to override possibly already present options
132	+	* @param initialize whether to initialize the option structure my_args_info
133	+	* @param check_required whether to check that all required options were provided
134	+	* @return 0 if everything went fine, NON 0 if an error took place
135	+	* @deprecated use cmdline_parser_ext() instead
136	+	*/
137	+	int cmdline_parser2 (int argc, char **argv,
138	+	struct gengetopt_args_info *args_info,
139	+	int override, int initialize, int check_required);
140	+
141	+	/**
142	+	* The command line parser (version with additional parameters)
143	+	* @param argc the number of command line options
144	+	* @param argv the command line options
145	+	* @param args_info the structure where option information will be stored
146	+	* @param params additional parameters for the parser
147	+	* @return 0 if everything went fine, NON 0 if an error took place
148	+	*/
149	+	int cmdline_parser_ext (int argc, char **argv,
150	+	struct gengetopt_args_info *args_info,
151	+	struct cmdline_parser_params *params);
152	+
153	+	/**
154	+	* Save the contents of the option struct into an already open FILE stream.
155	+	* @param outfile the stream where to dump options
156	+	* @param args_info the option struct to dump
157	+	* @return 0 if everything went fine, NON 0 if an error took place
158	+	*/
159	+	int cmdline_parser_dump(FILE *outfile,
160	+	struct gengetopt_args_info *args_info);
161	+
162	+	/**
163	+	* Save the contents of the option struct into a (text) file.
164	+	* This file can be read by the config file parser (if generated by gengetopt)
165	+	* @param filename the file where to save
166	+	* @param args_info the option struct to save
167	+	* @return 0 if everything went fine, NON 0 if an error took place
168	+	*/
169	+	int cmdline_parser_file_save(const char *filename,
170	+	struct gengetopt_args_info *args_info);
171	+
172	+	/**
173	+	* Print the help
174	+	*/
175		void cmdline_parser_print_help(void);
176	+	/**
177	+	* Print the version
178	+	*/
179		void cmdline_parser_print_version(void);
180
181	+	/**
182	+	* Initializes all the fields a cmdline_parser_params structure
183	+	* to their default values
184	+	* @param params the structure to initialize
185	+	*/
186	+	void cmdline_parser_params_init(struct cmdline_parser_params *params);
187	+
188	+	/**
189	+	* Allocates dynamically a cmdline_parser_params structure and initializes
190	+	* all its fields to their default values
191	+	* @return the created and initialized cmdline_parser_params structure
192	+	*/
193	+	struct cmdline_parser_params *cmdline_parser_params_create(void);
194	+
195	+	/**
196	+	* Initializes the passed gengetopt_args_info structure's fields
197	+	* (also set default values for options that have a default)
198	+	* @param args_info the structure to initialize
199	+	*/
200	+	void cmdline_parser_init (struct gengetopt_args_info *args_info);
201	+	/**
202	+	* Deallocates the string fields of the gengetopt_args_info structure
203	+	* (but does not deallocate the structure itself)
204	+	* @param args_info the structure to deallocate
205	+	*/
206	+	void cmdline_parser_free (struct gengetopt_args_info *args_info);
207	+
208	+	/**
209	+	* Checks that all the required options were specified
210	+	* @param args_info the structure to check
211	+	* @param prog_name the name of the program that will be used to print
212	+	*   possible errors
213	+	* @return
214	+	*/
215	+	int cmdline_parser_required (struct gengetopt_args_info *args_info,
216	+	const char *prog_name);
217	+
218	+
219		#ifdef __cplusplus
220		}
221		#endif /* __cplusplus */

Comparing trunk/src/applications/dynamicProps/DynamicPropsCmd.h (property svn:keywords):
Revision 876 by tim, Mon Jan 30 22:25:27 2006 UTC vs.
Revision 1811 by gezelter, Fri Nov 16 15:12:21 2012 UTC

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

Diff Legend

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