ViewVC Help

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

root/OpenMD/trunk/src/applications/randomBuilder/randomBuilderCmd.h

Comparing trunk/src/applications/randomBuilder/randomBuilderCmd.h (file contents):
Revision 950 by chuckv, Tue Apr 25 22:59:27 2006 UTC vs.
Revision 1782 by gezelter, Wed Aug 22 02:28:28 2012 UTC

#	Line 1 | Line 1
1	<	/* randomBuilderCmd.h */
1	>	/** @file randomBuilderCmd.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.15  */
4	–
8		#ifndef RANDOMBUILDERCMD_H
9		#define RANDOMBUILDERCMD_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	<	#define CMDLINE_PARSER_PACKAGE "simpleBuilder"
23	>	/** @brief the program name (used for printing errors) */
24	>	#define CMDLINE_PARSER_PACKAGE "randomBuilder"
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 "randomBuilder"
30	+	#endif
31	+
32		#ifndef CMDLINE_PARSER_VERSION
33	+	/** @brief the program version */
34		#define CMDLINE_PARSER_VERSION "1.0"
35		#endif
36
37	+	/** @brief Where the command line options are stored */
38		struct gengetopt_args_info
39		{
40	<	char * output_arg;    /* Output file name.  */
41	<	char * output_orig;   /* Output file name original value given at command line.  */
42	<	char * latticetype_arg;       /* Lattice type string. Valid types are fcc,hcp,bcc and hcp-water. (default='fcc').  */
43	<	char * latticetype_orig;      /* Lattice type string. Valid types are fcc,hcp,bcc and hcp-water. original value given at command line.  */
44	<	double density_arg;   /* density (g/cm^3).  */
45	<	char * density_orig;  /* density (g/cm^3) original value given at command line.  */
46	<	int nx_arg;   /* number of unit cells in x.  */
47	<	char * nx_orig;       /* number of unit cells in x original value given at command line.  */
48	<	int ny_arg;   /* number of unit cells in y.  */
49	<	char * ny_orig;       /* number of unit cells in y original value given at command line.  */
50	<	int nz_arg;   /* number of unit cells in z.  */
51	<	char * nz_orig;       /* number of unit cells in z original value given at command line.  */
52	<	double* molFraction_arg;      /* (Default) Builds a multi-component random mixed nanoparticle. Mole Fraction must be specified for each componet > 1 in MD file..  */
53	<	char ** molFraction_orig;     /* (Default) Builds a multi-component random mixed nanoparticle. Mole Fraction must be specified for each componet > 1 in MD file. original value given at command line.  */
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 * output_arg;    /**< @brief Output file name.  */
43	>	char * output_orig;   /**< @brief Output file name original value given at command line.  */
44	>	const char *output_help; /**< @brief Output file name help description.  */
45	>	double density_arg;   /**< @brief density (g/cm^3).  */
46	>	char * density_orig;  /**< @brief density (g/cm^3) original value given at command line.  */
47	>	const char *density_help; /**< @brief density (g/cm^3) help description.  */
48	>	int nx_arg;   /**< @brief number of unit cells in x.  */
49	>	char * nx_orig;       /**< @brief number of unit cells in x original value given at command line.  */
50	>	const char *nx_help; /**< @brief number of unit cells in x help description.  */
51	>	int ny_arg;   /**< @brief number of unit cells in y.  */
52	>	char * ny_orig;       /**< @brief number of unit cells in y original value given at command line.  */
53	>	const char *ny_help; /**< @brief number of unit cells in y help description.  */
54	>	int nz_arg;   /**< @brief number of unit cells in z.  */
55	>	char * nz_orig;       /**< @brief number of unit cells in z original value given at command line.  */
56	>	const char *nz_help; /**< @brief number of unit cells in z help description.  */
57	>	double* molFraction_arg;      /**< @brief (Default) Builds a multi-component random mixed nanoparticle. Mole Fraction must be specified for each componet > 1 in MD file..  */
58	>	char ** molFraction_orig;     /**< @brief (Default) Builds a multi-component random mixed nanoparticle. Mole Fraction must be specified for each componet > 1 in MD file. original value given at command line.  */
59	>	unsigned int molFraction_min; /**< @brief (Default) Builds a multi-component random mixed nanoparticle. Mole Fraction must be specified for each componet > 1 in MD file.'s minimum occurreces */
60	>	unsigned int molFraction_max; /**< @brief (Default) Builds a multi-component random mixed nanoparticle. Mole Fraction must be specified for each componet > 1 in MD file.'s maximum occurreces */
61	>	const char *molFraction_help; /**< @brief (Default) Builds a multi-component random mixed nanoparticle. Mole Fraction must be specified for each componet > 1 in MD file. help description.  */
62
63	<	int help_given ;      /* Whether help was given.  */
64	<	int version_given ;   /* Whether version was given.  */
65	<	int output_given ;    /* Whether output was given.  */
66	<	int latticetype_given ;       /* Whether latticetype was given.  */
67	<	int density_given ;   /* Whether density was given.  */
68	<	int nx_given ;        /* Whether nx was given.  */
69	<	int ny_given ;        /* Whether ny was given.  */
70	<	int nz_given ;        /* Whether nz was given.  */
50	<	unsigned int molFraction_given ;      /* Whether molFraction was given.  */
63	>	unsigned int help_given ;     /**< @brief Whether help was given.  */
64	>	unsigned int version_given ;  /**< @brief Whether version was given.  */
65	>	unsigned int output_given ;   /**< @brief Whether output was given.  */
66	>	unsigned int density_given ;  /**< @brief Whether density was given.  */
67	>	unsigned int nx_given ;       /**< @brief Whether nx was given.  */
68	>	unsigned int ny_given ;       /**< @brief Whether ny was given.  */
69	>	unsigned int nz_given ;       /**< @brief Whether nz was given.  */
70	>	unsigned int molFraction_given ;      /**< @brief Whether molFraction was given.  */
71
72	<	char **inputs ; /* unamed options */
73	<	unsigned inputs_num ; /* unamed options number */
72	>	char **inputs ; /**< @brief unamed options (options without names) */
73	>	unsigned inputs_num ; /**< @brief unamed options number */
74		} ;
75
76	<	int cmdline_parser (int argc, char * const *argv, struct gengetopt_args_info *args_info);
77	<	int cmdline_parser2 (int argc, char * const *argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required);
78	<	int cmdline_parser_file_save(const char *filename, struct gengetopt_args_info *args_info);
76	>	/** @brief The additional parameters to pass to parser functions */
77	>	struct cmdline_parser_params
78	>	{
79	>	int override; /**< @brief whether to override possibly already present options (default 0) */
80	>	int initialize; /**< @brief whether to initialize the option structure gengetopt_args_info (default 1) */
81	>	int check_required; /**< @brief whether to check that all required options were provided (default 1) */
82	>	int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */
83	>	int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
84	>	} ;
85
86	+	/** @brief the purpose string of the program */
87	+	extern const char *gengetopt_args_info_purpose;
88	+	/** @brief the usage string of the program */
89	+	extern const char *gengetopt_args_info_usage;
90	+	/** @brief all the lines making the help output */
91	+	extern const char *gengetopt_args_info_help[];
92	+
93	+	/**
94	+	* The command line parser
95	+	* @param argc the number of command line options
96	+	* @param argv the command line options
97	+	* @param args_info the structure where option information will be stored
98	+	* @return 0 if everything went fine, NON 0 if an error took place
99	+	*/
100	+	int cmdline_parser (int argc, char **argv,
101	+	struct gengetopt_args_info *args_info);
102	+
103	+	/**
104	+	* The command line parser (version with additional parameters - deprecated)
105	+	* @param argc the number of command line options
106	+	* @param argv the command line options
107	+	* @param args_info the structure where option information will be stored
108	+	* @param override whether to override possibly already present options
109	+	* @param initialize whether to initialize the option structure my_args_info
110	+	* @param check_required whether to check that all required options were provided
111	+	* @return 0 if everything went fine, NON 0 if an error took place
112	+	* @deprecated use cmdline_parser_ext() instead
113	+	*/
114	+	int cmdline_parser2 (int argc, char **argv,
115	+	struct gengetopt_args_info *args_info,
116	+	int override, int initialize, int check_required);
117	+
118	+	/**
119	+	* The command line parser (version with additional parameters)
120	+	* @param argc the number of command line options
121	+	* @param argv the command line options
122	+	* @param args_info the structure where option information will be stored
123	+	* @param params additional parameters for the parser
124	+	* @return 0 if everything went fine, NON 0 if an error took place
125	+	*/
126	+	int cmdline_parser_ext (int argc, char **argv,
127	+	struct gengetopt_args_info *args_info,
128	+	struct cmdline_parser_params *params);
129	+
130	+	/**
131	+	* Save the contents of the option struct into an already open FILE stream.
132	+	* @param outfile the stream where to dump options
133	+	* @param args_info the option struct to dump
134	+	* @return 0 if everything went fine, NON 0 if an error took place
135	+	*/
136	+	int cmdline_parser_dump(FILE *outfile,
137	+	struct gengetopt_args_info *args_info);
138	+
139	+	/**
140	+	* Save the contents of the option struct into a (text) file.
141	+	* This file can be read by the config file parser (if generated by gengetopt)
142	+	* @param filename the file where to save
143	+	* @param args_info the option struct to save
144	+	* @return 0 if everything went fine, NON 0 if an error took place
145	+	*/
146	+	int cmdline_parser_file_save(const char *filename,
147	+	struct gengetopt_args_info *args_info);
148	+
149	+	/**
150	+	* Print the help
151	+	*/
152		void cmdline_parser_print_help(void);
153	+	/**
154	+	* Print the version
155	+	*/
156		void cmdline_parser_print_version(void);
157
158	+	/**
159	+	* Initializes all the fields a cmdline_parser_params structure
160	+	* to their default values
161	+	* @param params the structure to initialize
162	+	*/
163	+	void cmdline_parser_params_init(struct cmdline_parser_params *params);
164	+
165	+	/**
166	+	* Allocates dynamically a cmdline_parser_params structure and initializes
167	+	* all its fields to their default values
168	+	* @return the created and initialized cmdline_parser_params structure
169	+	*/
170	+	struct cmdline_parser_params *cmdline_parser_params_create(void);
171	+
172	+	/**
173	+	* Initializes the passed gengetopt_args_info structure's fields
174	+	* (also set default values for options that have a default)
175	+	* @param args_info the structure to initialize
176	+	*/
177		void cmdline_parser_init (struct gengetopt_args_info *args_info);
178	+	/**
179	+	* Deallocates the string fields of the gengetopt_args_info structure
180	+	* (but does not deallocate the structure itself)
181	+	* @param args_info the structure to deallocate
182	+	*/
183		void cmdline_parser_free (struct gengetopt_args_info *args_info);
184
185	<	int cmdline_parser_required (struct gengetopt_args_info *args_info, const char *prog_name);
185	>	/**
186	>	* Checks that all the required options were specified
187	>	* @param args_info the structure to check
188	>	* @param prog_name the name of the program that will be used to print
189	>	*   possible errors
190	>	* @return
191	>	*/
192	>	int cmdline_parser_required (struct gengetopt_args_info *args_info,
193	>	const char *prog_name);
194
195
196		#ifdef __cplusplus

Comparing trunk/src/applications/randomBuilder/randomBuilderCmd.h (property svn:keywords):
Revision 950 by chuckv, Tue Apr 25 22:59:27 2006 UTC vs.
Revision 1782 by gezelter, Wed Aug 22 02:28:28 2012 UTC

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

Diff Legend

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