applications/dynamicProps/DynamicPropsCmd.h

/** @file DynamicPropsCmd.h
 *  @brief The header file for the command line option parser
 *  generated by GNU Gengetopt version 2.22.4
 *  http://www.gnu.org/software/gengetopt.
 *  DO NOT modify this file, since it can be overwritten
 *  @author GNU Gengetopt by Lorenzo Bettini */

#ifndef DYNAMICPROPSCMD_H
#define DYNAMICPROPSCMD_H

/* If we use autoconf.  */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdio.h> /* for FILE */

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#ifndef CMDLINE_PARSER_PACKAGE
/** @brief the program name (used for printing errors) */
#define CMDLINE_PARSER_PACKAGE "DynamicProps"
#endif

#ifndef CMDLINE_PARSER_PACKAGE_NAME
/** @brief the complete program name (used for help and version) */
#define CMDLINE_PARSER_PACKAGE_NAME "DynamicProps"
#endif

#ifndef CMDLINE_PARSER_VERSION
/** @brief the program version */
#define CMDLINE_PARSER_VERSION "1.00"
#endif

/** @brief Where the command line options are stored */
struct gengetopt_args_info
{
  const char *help_help; /**< @brief Print help and exit help description.  */
  const char *version_help; /**< @brief Print version and exit help description.  */
  char * input_arg;     /**< @brief input dump file.  */
  char * input_orig;    /**< @brief input dump file original value given at command line.  */
  const char *input_help; /**< @brief input dump file help description.  */
  char * output_arg;    /**< @brief output file name.  */
  char * output_orig;   /**< @brief output file name original value given at command line.  */
  const char *output_help; /**< @brief output file name help description.  */
  char * sele1_arg;     /**< @brief select first stuntdouble set.  */
  char * sele1_orig;    /**< @brief select first stuntdouble set original value given at command line.  */
  const char *sele1_help; /**< @brief select first stuntdouble set help description.  */
  char * sele2_arg;     /**< @brief select second stuntdouble set (if sele2 is not set, use script from sele1).  */
  char * sele2_orig;    /**< @brief select second stuntdouble set (if sele2 is not set, use script from sele1) original value given at command line.  */
  const char *sele2_help; /**< @brief select second stuntdouble set (if sele2 is not set, use script from sele1) help description.  */
  int order_arg;        /**< @brief Lengendre Polynomial Order.  */
  char * order_orig;    /**< @brief Lengendre Polynomial Order original value given at command line.  */
  const char *order_help; /**< @brief Lengendre Polynomial Order help description.  */
  int nzbins_arg;       /**< @brief Number of Z bins (default='100').  */
  char * nzbins_orig;   /**< @brief Number of Z bins original value given at command line.  */
  const char *nzbins_help; /**< @brief Number of Z bins help description.  */
  char * memory_arg;    /**< @brief Available memory (defaults to 2G) (default='2G').  */
  char * memory_orig;   /**< @brief Available memory (defaults to 2G) original value given at command line.  */
  const char *memory_help; /**< @brief Available memory (defaults to 2G) help description.  */
  const char *selecorr_help; /**< @brief selection correlation function help description.  */
  const char *rcorr_help; /**< @brief rmsd help description.  */
  const char *vcorr_help; /**< @brief velocity correlation function help description.  */
  const char *dcorr_help; /**< @brief dipole correlation function help description.  */
  const char *lcorr_help; /**< @brief Lengendre correlation function help description.  */
  const char *lcorrZ_help; /**< @brief Lengendre correlation function binned by Z help description.  */
  const char *cohZ_help; /**< @brief Lengendre correlation function for OH bond vectors binned by Z help description.  */
  const char *sdcorr_help; /**< @brief System dipole correlation function help description.  */
  const char *r_rcorr_help; /**< @brief Radial rmsd help description.  */
  const char *thetacorr_help; /**< @brief Angular rmsd help description.  */
  const char *drcorr_help; /**< @brief Directional rmsd for particles with unit vectors help description.  */
  const char *helfandEcorr_help; /**< @brief Helfand moment for thermal conductvity help description.  */
  const char *momentum_help; /**< @brief Helfand momentum for viscosity help description.  */
  const char *stresscorr_help; /**< @brief Stress tensor correlation function help description.  */
  const char *bondcorr_help; /**< @brief Bond extension correlation function help description.  */
  
  unsigned int help_given ;     /**< @brief Whether help was given.  */
  unsigned int version_given ;  /**< @brief Whether version was given.  */
  unsigned int input_given ;    /**< @brief Whether input was given.  */
  unsigned int output_given ;   /**< @brief Whether output was given.  */
  unsigned int sele1_given ;    /**< @brief Whether sele1 was given.  */
  unsigned int sele2_given ;    /**< @brief Whether sele2 was given.  */
  unsigned int order_given ;    /**< @brief Whether order was given.  */
  unsigned int nzbins_given ;   /**< @brief Whether nzbins was given.  */
  unsigned int memory_given ;   /**< @brief Whether memory was given.  */
  unsigned int selecorr_given ; /**< @brief Whether selecorr was given.  */
  unsigned int rcorr_given ;    /**< @brief Whether rcorr was given.  */
  unsigned int vcorr_given ;    /**< @brief Whether vcorr was given.  */
  unsigned int dcorr_given ;    /**< @brief Whether dcorr was given.  */
  unsigned int lcorr_given ;    /**< @brief Whether lcorr was given.  */
  unsigned int lcorrZ_given ;   /**< @brief Whether lcorrZ was given.  */
  unsigned int cohZ_given ;     /**< @brief Whether cohZ was given.  */
  unsigned int sdcorr_given ;   /**< @brief Whether sdcorr was given.  */
  unsigned int r_rcorr_given ;  /**< @brief Whether r_rcorr was given.  */
  unsigned int thetacorr_given ;        /**< @brief Whether thetacorr was given.  */
  unsigned int drcorr_given ;   /**< @brief Whether drcorr was given.  */
  unsigned int helfandEcorr_given ;     /**< @brief Whether helfandEcorr was given.  */
  unsigned int momentum_given ; /**< @brief Whether momentum was given.  */
  unsigned int stresscorr_given ;       /**< @brief Whether stresscorr was given.  */
  unsigned int bondcorr_given ; /**< @brief Whether bondcorr was given.  */

  char **inputs ; /**< @brief unamed options (options without names) */
  unsigned inputs_num ; /**< @brief unamed options number */
  int dynamicProps_group_counter; /**< @brief Counter for group dynamicProps */
} ;

/** @brief The additional parameters to pass to parser functions */
struct cmdline_parser_params
{
  int override; /**< @brief whether to override possibly already present options (default 0) */
  int initialize; /**< @brief whether to initialize the option structure gengetopt_args_info (default 1) */
  int check_required; /**< @brief whether to check that all required options were provided (default 1) */
  int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */
  int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
} ;

/** @brief the purpose string of the program */
extern const char *gengetopt_args_info_purpose;
/** @brief the usage string of the program */
extern const char *gengetopt_args_info_usage;
/** @brief all the lines making the help output */
extern const char *gengetopt_args_info_help[];

/**
 * The command line parser
 * @param argc the number of command line options
 * @param argv the command line options
 * @param args_info the structure where option information will be stored
 * @return 0 if everything went fine, NON 0 if an error took place
 */
int cmdline_parser (int argc, char **argv,
  struct gengetopt_args_info *args_info);

/**
 * The command line parser (version with additional parameters - deprecated)
 * @param argc the number of command line options
 * @param argv the command line options
 * @param args_info the structure where option information will be stored
 * @param override whether to override possibly already present options
 * @param initialize whether to initialize the option structure my_args_info
 * @param check_required whether to check that all required options were provided
 * @return 0 if everything went fine, NON 0 if an error took place
 * @deprecated use cmdline_parser_ext() instead
 */
int cmdline_parser2 (int argc, char **argv,
  struct gengetopt_args_info *args_info,
  int override, int initialize, int check_required);

/**
 * The command line parser (version with additional parameters)
 * @param argc the number of command line options
 * @param argv the command line options
 * @param args_info the structure where option information will be stored
 * @param params additional parameters for the parser
 * @return 0 if everything went fine, NON 0 if an error took place
 */
int cmdline_parser_ext (int argc, char **argv,
  struct gengetopt_args_info *args_info,
  struct cmdline_parser_params *params);

/**
 * Save the contents of the option struct into an already open FILE stream.
 * @param outfile the stream where to dump options
 * @param args_info the option struct to dump
 * @return 0 if everything went fine, NON 0 if an error took place
 */
int cmdline_parser_dump(FILE *outfile,
  struct gengetopt_args_info *args_info);

/**
 * Save the contents of the option struct into a (text) file.
 * This file can be read by the config file parser (if generated by gengetopt)
 * @param filename the file where to save
 * @param args_info the option struct to save
 * @return 0 if everything went fine, NON 0 if an error took place
 */
int cmdline_parser_file_save(const char *filename,
  struct gengetopt_args_info *args_info);

/**
 * Print the help
 */
void cmdline_parser_print_help(void);
/**
 * Print the version
 */
void cmdline_parser_print_version(void);

/**
 * Initializes all the fields a cmdline_parser_params structure 
 * to their default values
 * @param params the structure to initialize
 */
void cmdline_parser_params_init(struct cmdline_parser_params *params);

/**
 * Allocates dynamically a cmdline_parser_params structure and initializes
 * all its fields to their default values
 * @return the created and initialized cmdline_parser_params structure
 */
struct cmdline_parser_params *cmdline_parser_params_create(void);

/**
 * Initializes the passed gengetopt_args_info structure's fields
 * (also set default values for options that have a default)
 * @param args_info the structure to initialize
 */
void cmdline_parser_init (struct gengetopt_args_info *args_info);
/**
 * Deallocates the string fields of the gengetopt_args_info structure
 * (but does not deallocate the structure itself)
 * @param args_info the structure to deallocate
 */
void cmdline_parser_free (struct gengetopt_args_info *args_info);

/**
 * Checks that all the required options were specified
 * @param args_info the structure to check
 * @param prog_name the name of the program that will be used to print
 *   possible errors
 * @return
 */
int cmdline_parser_required (struct gengetopt_args_info *args_info,
  const char *prog_name);


#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* DYNAMICPROPSCMD_H */
Revision:	1953
Committed:	Thu Dec 5 18:19:26 2013 UTC (11 years, 4 months ago) by gezelter
Content type:	text/plain
File size:	11179 byte(s)
Log Message:	Rewrote much of selection module, added a bond correlation function
#	User	Rev	Content
1	gezelter	1596	/** @file DynamicPropsCmd.h
2	chuckv	1565	* @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	tim	320
8	gezelter	1596	#ifndef DYNAMICPROPSCMD_H
9			#define DYNAMICPROPSCMD_H
10	tim	320
11			/* If we use autoconf. */
12			#ifdef HAVE_CONFIG_H
13			#include "config.h"
14			#endif
15
16	chuckv	1565	#include <stdio.h> /* for FILE */
17
18	tim	320	#ifdef __cplusplus
19			extern "C" {
20			#endif /* __cplusplus */
21
22			#ifndef CMDLINE_PARSER_PACKAGE
23	chuckv	1565	/** @brief the program name (used for printing errors) */
24	tim	320	#define CMDLINE_PARSER_PACKAGE "DynamicProps"
25			#endif
26
27	chuckv	1565	#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	tim	320	#ifndef CMDLINE_PARSER_VERSION
33	chuckv	1565	/** @brief the program version */
34	tim	320	#define CMDLINE_PARSER_VERSION "1.00"
35			#endif
36
37	chuckv	1565	/** @brief Where the command line options are stored */
38	tim	876	struct gengetopt_args_info
39			{
40	chuckv	1565	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	gezelter	1915	int nzbins_arg; /*< @brief Number of Z bins (default='100'). /
58			char * nzbins_orig; /*< @brief Number of Z bins original value given at command line. /
59			const char nzbins_help; /< @brief Number of Z bins help description. /
60	gezelter	1596	char * memory_arg; /*< @brief Available memory (defaults to 2G) (default='2G'). /
61			char * memory_orig; /*< @brief Available memory (defaults to 2G) original value given at command line. /
62			const char memory_help; /< @brief Available memory (defaults to 2G) help description. /
63	gezelter	1811	const char selecorr_help; /< @brief selection correlation function help description. /
64	chuckv	1565	const char rcorr_help; /< @brief rmsd help description. /
65			const char vcorr_help; /< @brief velocity correlation function help description. /
66			const char dcorr_help; /< @brief dipole correlation function help description. /
67			const char lcorr_help; /< @brief Lengendre correlation function help description. /
68	gezelter	1915	const char lcorrZ_help; /< @brief Lengendre correlation function binned by Z help description. /
69	gezelter	1934	const char cohZ_help; /< @brief Lengendre correlation function for OH bond vectors binned by Z help description. /
70	jmichalk	1604	const char sdcorr_help; /< @brief System dipole correlation function help description. /
71	chuckv	1565	const char r_rcorr_help; /< @brief Radial rmsd help description. /
72			const char thetacorr_help; /< @brief Angular rmsd help description. /
73			const char drcorr_help; /< @brief Directional rmsd for particles with unit vectors help description. /
74			const char helfandEcorr_help; /< @brief Helfand moment for thermal conductvity help description. /
75	gezelter	1615	const char momentum_help; /< @brief Helfand momentum for viscosity help description. /
76	chuckv	1565	const char stresscorr_help; /< @brief Stress tensor correlation function help description. /
77	gezelter	1953	const char bondcorr_help; /< @brief Bond extension correlation function help description. /
78	chuckv	1098
79	chuckv	1565	unsigned int help_given ; /*< @brief Whether help was given. /
80			unsigned int version_given ; /*< @brief Whether version was given. /
81			unsigned int input_given ; /*< @brief Whether input was given. /
82			unsigned int output_given ; /*< @brief Whether output was given. /
83			unsigned int sele1_given ; /*< @brief Whether sele1 was given. /
84			unsigned int sele2_given ; /*< @brief Whether sele2 was given. /
85			unsigned int order_given ; /*< @brief Whether order was given. /
86	gezelter	1915	unsigned int nzbins_given ; /*< @brief Whether nzbins was given. /
87	gezelter	1596	unsigned int memory_given ; /*< @brief Whether memory was given. /
88	gezelter	1811	unsigned int selecorr_given ; /*< @brief Whether selecorr was given. /
89	chuckv	1565	unsigned int rcorr_given ; /*< @brief Whether rcorr was given. /
90			unsigned int vcorr_given ; /*< @brief Whether vcorr was given. /
91			unsigned int dcorr_given ; /*< @brief Whether dcorr was given. /
92			unsigned int lcorr_given ; /*< @brief Whether lcorr was given. /
93	gezelter	1915	unsigned int lcorrZ_given ; /*< @brief Whether lcorrZ was given. /
94	gezelter	1934	unsigned int cohZ_given ; /*< @brief Whether cohZ was given. /
95	jmichalk	1604	unsigned int sdcorr_given ; /*< @brief Whether sdcorr was given. /
96	chuckv	1565	unsigned int r_rcorr_given ; /*< @brief Whether r_rcorr was given. /
97			unsigned int thetacorr_given ; /*< @brief Whether thetacorr was given. /
98			unsigned int drcorr_given ; /*< @brief Whether drcorr was given. /
99			unsigned int helfandEcorr_given ; /*< @brief Whether helfandEcorr was given. /
100	gezelter	1615	unsigned int momentum_given ; /*< @brief Whether momentum was given. /
101	chuckv	1565	unsigned int stresscorr_given ; /*< @brief Whether stresscorr was given. /
102	gezelter	1953	unsigned int bondcorr_given ; /*< @brief Whether bondcorr was given. /
103	tim	320
104	gezelter	1615	char inputs ; /< @brief unamed options (options without names) */
105			unsigned inputs_num ; /*< @brief unamed options number /
106	chuckv	1565	int dynamicProps_group_counter; /*< @brief Counter for group dynamicProps /
107	tim	876	} ;
108	tim	320
109	chuckv	1565	/** @brief The additional parameters to pass to parser functions */
110			struct cmdline_parser_params
111			{
112			int override; /*< @brief whether to override possibly already present options (default 0) /
113			int initialize; /*< @brief whether to initialize the option structure gengetopt_args_info (default 1) /
114			int check_required; /*< @brief whether to check that all required options were provided (default 1) /
115			int check_ambiguity; /*< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) /
116			int print_errors; /*< @brief whether getopt_long should print an error message for a bad option (default 1) /
117			} ;
118	tim	320
119	chuckv	1565	/** @brief the purpose string of the program */
120			extern const char *gengetopt_args_info_purpose;
121			/** @brief the usage string of the program */
122			extern const char *gengetopt_args_info_usage;
123			/** @brief all the lines making the help output */
124			extern const char *gengetopt_args_info_help[];
125
126			/**
127			* The command line parser
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			* @return 0 if everything went fine, NON 0 if an error took place
132			*/
133			int cmdline_parser (int argc, char **argv,
134			struct gengetopt_args_info *args_info);
135
136			/**
137			* The command line parser (version with additional parameters - deprecated)
138			* @param argc the number of command line options
139			* @param argv the command line options
140			* @param args_info the structure where option information will be stored
141			* @param override whether to override possibly already present options
142			* @param initialize whether to initialize the option structure my_args_info
143			* @param check_required whether to check that all required options were provided
144			* @return 0 if everything went fine, NON 0 if an error took place
145			* @deprecated use cmdline_parser_ext() instead
146			*/
147			int cmdline_parser2 (int argc, char **argv,
148			struct gengetopt_args_info *args_info,
149			int override, int initialize, int check_required);
150
151			/**
152			* The command line parser (version with additional parameters)
153			* @param argc the number of command line options
154			* @param argv the command line options
155			* @param args_info the structure where option information will be stored
156			* @param params additional parameters for the parser
157			* @return 0 if everything went fine, NON 0 if an error took place
158			*/
159			int cmdline_parser_ext (int argc, char **argv,
160			struct gengetopt_args_info *args_info,
161			struct cmdline_parser_params *params);
162
163			/**
164			* Save the contents of the option struct into an already open FILE stream.
165			* @param outfile the stream where to dump options
166			* @param args_info the option struct to dump
167			* @return 0 if everything went fine, NON 0 if an error took place
168			*/
169			int cmdline_parser_dump(FILE *outfile,
170			struct gengetopt_args_info *args_info);
171
172			/**
173			* Save the contents of the option struct into a (text) file.
174			* This file can be read by the config file parser (if generated by gengetopt)
175			* @param filename the file where to save
176			* @param args_info the option struct to save
177			* @return 0 if everything went fine, NON 0 if an error took place
178			*/
179			int cmdline_parser_file_save(const char *filename,
180			struct gengetopt_args_info *args_info);
181
182			/**
183			* Print the help
184			*/
185	tim	876	void cmdline_parser_print_help(void);
186	chuckv	1565	/**
187			* Print the version
188			*/
189	tim	876	void cmdline_parser_print_version(void);
190	tim	320
191	chuckv	1565	/**
192			* Initializes all the fields a cmdline_parser_params structure
193			* to their default values
194			* @param params the structure to initialize
195			*/
196			void cmdline_parser_params_init(struct cmdline_parser_params *params);
197
198			/**
199			* Allocates dynamically a cmdline_parser_params structure and initializes
200			* all its fields to their default values
201			* @return the created and initialized cmdline_parser_params structure
202			*/
203			struct cmdline_parser_params *cmdline_parser_params_create(void);
204
205			/**
206			* Initializes the passed gengetopt_args_info structure's fields
207			* (also set default values for options that have a default)
208			* @param args_info the structure to initialize
209			*/
210	chuckv	1098	void cmdline_parser_init (struct gengetopt_args_info *args_info);
211	chuckv	1565	/**
212			* Deallocates the string fields of the gengetopt_args_info structure
213			* (but does not deallocate the structure itself)
214			* @param args_info the structure to deallocate
215			*/
216	chuckv	1098	void cmdline_parser_free (struct gengetopt_args_info *args_info);
217
218	chuckv	1565	/**
219			* Checks that all the required options were specified
220			* @param args_info the structure to check
221			* @param prog_name the name of the program that will be used to print
222			* possible errors
223			* @return
224			*/
225			int cmdline_parser_required (struct gengetopt_args_info *args_info,
226			const char *prog_name);
227	chuckv	1098
228
229	tim	320	#ifdef __cplusplus
230			}
231			#endif /* __cplusplus */
232	gezelter	1596	#endif /* DYNAMICPROPSCMD_H */