applications/dynamicProps/DynamicPropsCmd.h

/** @file cmdline.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 CMDLINE_H
#define CMDLINE_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.  */
  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 *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 *stresscorr_help; /**< @brief Stress tensor 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 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 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 stresscorr_given ;       /**< @brief Whether stresscorr was given.  */

  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 /* CMDLINE_H */
Revision:	1565
Committed:	Thu May 19 14:28:04 2011 UTC (13 years, 11 months ago) by chuckv
Content type:	text/plain
File size:	9290 byte(s)
Log Message:	Added files for stress correlation funcion.
#	Content
1	/** @file cmdline.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
8	#ifndef CMDLINE_H
9	#define CMDLINE_H
10
11	/* If we use autoconf. */
12	#ifdef HAVE_CONFIG_H
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	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	const char rcorr_help; /< @brief rmsd help description. /
58	const char vcorr_help; /< @brief velocity correlation function help description. /
59	const char dcorr_help; /< @brief dipole correlation function help description. /
60	const char lcorr_help; /< @brief Lengendre correlation function help description. /
61	const char r_rcorr_help; /< @brief Radial rmsd help description. /
62	const char thetacorr_help; /< @brief Angular rmsd help description. /
63	const char drcorr_help; /< @brief Directional rmsd for particles with unit vectors help description. /
64	const char helfandEcorr_help; /< @brief Helfand moment for thermal conductvity help description. /
65	const char stresscorr_help; /< @brief Stress tensor correlation function help description. /
66
67	unsigned int help_given ; /*< @brief Whether help was given. /
68	unsigned int version_given ; /*< @brief Whether version was given. /
69	unsigned int input_given ; /*< @brief Whether input was given. /
70	unsigned int output_given ; /*< @brief Whether output was given. /
71	unsigned int sele1_given ; /*< @brief Whether sele1 was given. /
72	unsigned int sele2_given ; /*< @brief Whether sele2 was given. /
73	unsigned int order_given ; /*< @brief Whether order was given. /
74	unsigned int rcorr_given ; /*< @brief Whether rcorr was given. /
75	unsigned int vcorr_given ; /*< @brief Whether vcorr was given. /
76	unsigned int dcorr_given ; /*< @brief Whether dcorr was given. /
77	unsigned int lcorr_given ; /*< @brief Whether lcorr was given. /
78	unsigned int r_rcorr_given ; /*< @brief Whether r_rcorr was given. /
79	unsigned int thetacorr_given ; /*< @brief Whether thetacorr was given. /
80	unsigned int drcorr_given ; /*< @brief Whether drcorr was given. /
81	unsigned int helfandEcorr_given ; /*< @brief Whether helfandEcorr was given. /
82	unsigned int stresscorr_given ; /*< @brief Whether stresscorr was given. /
83
84	int dynamicProps_group_counter; /*< @brief Counter for group dynamicProps /
85	} ;
86
87	/** @brief The additional parameters to pass to parser functions */
88	struct cmdline_parser_params
89	{
90	int override; /*< @brief whether to override possibly already present options (default 0) /
91	int initialize; /*< @brief whether to initialize the option structure gengetopt_args_info (default 1) /
92	int check_required; /*< @brief whether to check that all required options were provided (default 1) /
93	int check_ambiguity; /*< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) /
94	int print_errors; /*< @brief whether getopt_long should print an error message for a bad option (default 1) /
95	} ;
96
97	/** @brief the purpose string of the program */
98	extern const char *gengetopt_args_info_purpose;
99	/** @brief the usage string of the program */
100	extern const char *gengetopt_args_info_usage;
101	/** @brief all the lines making the help output */
102	extern const char *gengetopt_args_info_help[];
103
104	/**
105	* The command line parser
106	* @param argc the number of command line options
107	* @param argv the command line options
108	* @param args_info the structure where option information will be stored
109	* @return 0 if everything went fine, NON 0 if an error took place
110	*/
111	int cmdline_parser (int argc, char **argv,
112	struct gengetopt_args_info *args_info);
113
114	/**
115	* The command line parser (version with additional parameters - deprecated)
116	* @param argc the number of command line options
117	* @param argv the command line options
118	* @param args_info the structure where option information will be stored
119	* @param override whether to override possibly already present options
120	* @param initialize whether to initialize the option structure my_args_info
121	* @param check_required whether to check that all required options were provided
122	* @return 0 if everything went fine, NON 0 if an error took place
123	* @deprecated use cmdline_parser_ext() instead
124	*/
125	int cmdline_parser2 (int argc, char **argv,
126	struct gengetopt_args_info *args_info,
127	int override, int initialize, int check_required);
128
129	/**
130	* The command line parser (version with additional parameters)
131	* @param argc the number of command line options
132	* @param argv the command line options
133	* @param args_info the structure where option information will be stored
134	* @param params additional parameters for the parser
135	* @return 0 if everything went fine, NON 0 if an error took place
136	*/
137	int cmdline_parser_ext (int argc, char **argv,
138	struct gengetopt_args_info *args_info,
139	struct cmdline_parser_params *params);
140
141	/**
142	* Save the contents of the option struct into an already open FILE stream.
143	* @param outfile the stream where to dump options
144	* @param args_info the option struct to dump
145	* @return 0 if everything went fine, NON 0 if an error took place
146	*/
147	int cmdline_parser_dump(FILE *outfile,
148	struct gengetopt_args_info *args_info);
149
150	/**
151	* Save the contents of the option struct into a (text) file.
152	* This file can be read by the config file parser (if generated by gengetopt)
153	* @param filename the file where to save
154	* @param args_info the option struct to save
155	* @return 0 if everything went fine, NON 0 if an error took place
156	*/
157	int cmdline_parser_file_save(const char *filename,
158	struct gengetopt_args_info *args_info);
159
160	/**
161	* Print the help
162	*/
163	void cmdline_parser_print_help(void);
164	/**
165	* Print the version
166	*/
167	void cmdline_parser_print_version(void);
168
169	/**
170	* Initializes all the fields a cmdline_parser_params structure
171	* to their default values
172	* @param params the structure to initialize
173	*/
174	void cmdline_parser_params_init(struct cmdline_parser_params *params);
175
176	/**
177	* Allocates dynamically a cmdline_parser_params structure and initializes
178	* all its fields to their default values
179	* @return the created and initialized cmdline_parser_params structure
180	*/
181	struct cmdline_parser_params *cmdline_parser_params_create(void);
182
183	/**
184	* Initializes the passed gengetopt_args_info structure's fields
185	* (also set default values for options that have a default)
186	* @param args_info the structure to initialize
187	*/
188	void cmdline_parser_init (struct gengetopt_args_info *args_info);
189	/**
190	* Deallocates the string fields of the gengetopt_args_info structure
191	* (but does not deallocate the structure itself)
192	* @param args_info the structure to deallocate
193	*/
194	void cmdline_parser_free (struct gengetopt_args_info *args_info);
195
196	/**
197	* Checks that all the required options were specified
198	* @param args_info the structure to check
199	* @param prog_name the name of the program that will be used to print
200	* possible errors
201	* @return
202	*/
203	int cmdline_parser_required (struct gengetopt_args_info *args_info,
204	const char *prog_name);
205
206
207	#ifdef __cplusplus
208	}
209	#endif /* __cplusplus */
210	#endif /* CMDLINE_H */