applications/staticProps/StaticPropsCmd.h

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

#ifndef STATICPROPSCMD_H
#define STATICPROPSCMD_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 */
#define CMDLINE_PARSER_PACKAGE "StaticProps"
#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.  */
  int step_arg; /**< @brief process every n frame (default='1').  */
  char * step_orig;     /**< @brief process every n frame original value given at command line.  */
  const char *step_help; /**< @brief process every n frame help description.  */
  int nbins_arg;        /**< @brief number of bins (general purpose) (default='100').  */
  char * nbins_orig;    /**< @brief number of bins (general purpose) original value given at command line.  */
  const char *nbins_help; /**< @brief number of bins (general purpose) help description.  */
  int nbins_x_arg;      /**< @brief number of bins in x axis (default='100').  */
  char * nbins_x_orig;  /**< @brief number of bins in x axis original value given at command line.  */
  const char *nbins_x_help; /**< @brief number of bins in x axis help description.  */
  int nbins_y_arg;      /**< @brief number of bins in y axis (default='100').  */
  char * nbins_y_orig;  /**< @brief number of bins in y axis original value given at command line.  */
  const char *nbins_y_help; /**< @brief number of bins in y axis help description.  */
  int nbins_z_arg;      /**< @brief number of bins in z axis (default='100').  */
  char * nbins_z_orig;  /**< @brief number of bins in z axis original value given at command line.  */
  const char *nbins_z_help; /**< @brief number of bins in z axis help description.  */
  int nanglebins_arg;   /**< @brief number of bins for cos(angle) (default='50').  */
  char * nanglebins_orig;       /**< @brief number of bins for cos(angle) original value given at command line.  */
  const char *nanglebins_help; /**< @brief number of bins for cos(angle) help description.  */
  double rcut_arg;      /**< @brief cutoff radius (rcut).  */
  char * rcut_orig;     /**< @brief cutoff radius (rcut) original value given at command line.  */
  const char *rcut_help; /**< @brief cutoff radius (rcut) help description.  */
  double length_arg;    /**< @brief maximum length (Defaults to 1/2 smallest length of first frame).  */
  char * length_orig;   /**< @brief maximum length (Defaults to 1/2 smallest length of first frame) original value given at command line.  */
  const char *length_help; /**< @brief maximum length (Defaults to 1/2 smallest length of first frame) help description.  */
  double zlength_arg;   /**< @brief maximum length (Defaults to 1/2 smallest length of first frame).  */
  char * zlength_orig;  /**< @brief maximum length (Defaults to 1/2 smallest length of first frame) original value given at command line.  */
  const char *zlength_help; /**< @brief maximum length (Defaults to 1/2 smallest length of first frame) help description.  */
  double zoffset_arg;   /**< @brief Where to set the zero for the slab_density calculation (default='0').  */
  char * zoffset_orig;  /**< @brief Where to set the zero for the slab_density calculation original value given at command line.  */
  const char *zoffset_help; /**< @brief Where to set the zero for the slab_density calculation help description.  */
  char * sele1_arg;     /**< @brief select the first stuntdouble set.  */
  char * sele1_orig;    /**< @brief select the first stuntdouble set original value given at command line.  */
  const char *sele1_help; /**< @brief select the first stuntdouble set help description.  */
  char * sele2_arg;     /**< @brief select the second stuntdouble set.  */
  char * sele2_orig;    /**< @brief select the second stuntdouble set original value given at command line.  */
  const char *sele2_help; /**< @brief select the second stuntdouble set help description.  */
  char * sele3_arg;     /**< @brief select the third stuntdouble set.  */
  char * sele3_orig;    /**< @brief select the third stuntdouble set original value given at command line.  */
  const char *sele3_help; /**< @brief select the third stuntdouble set help description.  */
  char * refsele_arg;   /**< @brief select reference (use and only use with --gxyz).  */
  char * refsele_orig;  /**< @brief select reference (use and only use with --gxyz) original value given at command line.  */
  const char *refsele_help; /**< @brief select reference (use and only use with --gxyz) help description.  */
  char * comsele_arg;   /**< @brief select stunt doubles for center-of-mass reference point.  */
  char * comsele_orig;  /**< @brief select stunt doubles for center-of-mass reference point original value given at command line.  */
  const char *comsele_help; /**< @brief select stunt doubles for center-of-mass reference point help description.  */
  char * molname_arg;   /**< @brief molecule name.  */
  char * molname_orig;  /**< @brief molecule name original value given at command line.  */
  const char *molname_help; /**< @brief molecule name help description.  */
  int begin_arg;        /**< @brief begin internal index.  */
  char * begin_orig;    /**< @brief begin internal index original value given at command line.  */
  const char *begin_help; /**< @brief begin internal index help description.  */
  int end_arg;  /**< @brief end internal index.  */
  char * end_orig;      /**< @brief end internal index original value given at command line.  */
  const char *end_help; /**< @brief end internal index help description.  */
  double radius_arg;    /**< @brief nanoparticle radius.  */
  char * radius_orig;   /**< @brief nanoparticle radius original value given at command line.  */
  const char *radius_help; /**< @brief nanoparticle radius help description.  */
  const char *bo_help; /**< @brief bond order parameter (--rcut must be specified) help description.  */
  const char *bor_help; /**< @brief bond order parameter as a function of radius (--rcut must be specified) help description.  */
  const char *bad_help; /**< @brief N(theta) bond angle density within (--rcut must be specified) help description.  */
  const char *gofr_help; /**< @brief g(r) help description.  */
  const char *gofz_help; /**< @brief g(z) help description.  */
  const char *r_theta_help; /**< @brief g(r, cos(theta)) help description.  */
  const char *r_omega_help; /**< @brief g(r, cos(omega)) help description.  */
  const char *r_z_help; /**< @brief g(r, z) help description.  */
  const char *theta_omega_help; /**< @brief g(cos(theta), cos(omega)) help description.  */
  const char *gxyz_help; /**< @brief g(x, y, z) help description.  */
  const char *p2_help; /**< @brief p2 order parameter (--sele1 and --sele2 must be specified) help description.  */
  const char *rp2_help; /**< @brief rp2 order parameter (--sele1 and --sele2 must be specified) help description.  */
  const char *scd_help; /**< @brief scd order parameter (either --sele1, --sele2, --sele3 are specified or --molname, --begin, --end are specified) help description.  */
  const char *density_help; /**< @brief density plot help description.  */
  const char *slab_density_help; /**< @brief slab density help description.  */
  const char *p_angle_help; /**< @brief p(cos(theta)) help description.  */
  const char *hxy_help; /**< @brief hxy help description.  */
  const char *rho_r_help; /**< @brief rho of R help description.  */
  const char *hullvol_help; /**< @brief hull volume of nanoparticle 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 step_given ;     /**< @brief Whether step was given.  */
  unsigned int nbins_given ;    /**< @brief Whether nbins was given.  */
  unsigned int nbins_x_given ;  /**< @brief Whether nbins_x was given.  */
  unsigned int nbins_y_given ;  /**< @brief Whether nbins_y was given.  */
  unsigned int nbins_z_given ;  /**< @brief Whether nbins_z was given.  */
  unsigned int nanglebins_given ;       /**< @brief Whether nanglebins was given.  */
  unsigned int rcut_given ;     /**< @brief Whether rcut was given.  */
  unsigned int length_given ;   /**< @brief Whether length was given.  */
  unsigned int zlength_given ;  /**< @brief Whether zlength was given.  */
  unsigned int zoffset_given ;  /**< @brief Whether zoffset was given.  */
  unsigned int sele1_given ;    /**< @brief Whether sele1 was given.  */
  unsigned int sele2_given ;    /**< @brief Whether sele2 was given.  */
  unsigned int sele3_given ;    /**< @brief Whether sele3 was given.  */
  unsigned int refsele_given ;  /**< @brief Whether refsele was given.  */
  unsigned int comsele_given ;  /**< @brief Whether comsele was given.  */
  unsigned int molname_given ;  /**< @brief Whether molname was given.  */
  unsigned int begin_given ;    /**< @brief Whether begin was given.  */
  unsigned int end_given ;      /**< @brief Whether end was given.  */
  unsigned int radius_given ;   /**< @brief Whether radius was given.  */
  unsigned int bo_given ;       /**< @brief Whether bo was given.  */
  unsigned int bor_given ;      /**< @brief Whether bor was given.  */
  unsigned int bad_given ;      /**< @brief Whether bad was given.  */
  unsigned int gofr_given ;     /**< @brief Whether gofr was given.  */
  unsigned int gofz_given ;     /**< @brief Whether gofz was given.  */
  unsigned int r_theta_given ;  /**< @brief Whether r_theta was given.  */
  unsigned int r_omega_given ;  /**< @brief Whether r_omega was given.  */
  unsigned int r_z_given ;      /**< @brief Whether r_z was given.  */
  unsigned int theta_omega_given ;      /**< @brief Whether theta_omega was given.  */
  unsigned int gxyz_given ;     /**< @brief Whether gxyz was given.  */
  unsigned int p2_given ;       /**< @brief Whether p2 was given.  */
  unsigned int rp2_given ;      /**< @brief Whether rp2 was given.  */
  unsigned int scd_given ;      /**< @brief Whether scd was given.  */
  unsigned int density_given ;  /**< @brief Whether density was given.  */
  unsigned int slab_density_given ;     /**< @brief Whether slab_density was given.  */
  unsigned int p_angle_given ;  /**< @brief Whether p_angle was given.  */
  unsigned int hxy_given ;      /**< @brief Whether hxy was given.  */
  unsigned int rho_r_given ;    /**< @brief Whether rho_r was given.  */
  unsigned int hullvol_given ;  /**< @brief Whether hullvol was given.  */

  int staticProps_group_counter; /**< @brief Counter for group staticProps */
} ;

/** @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 * const *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 * const *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 * const *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 /* STATICPROPSCMD_H */
Revision:	1445
Committed:	Tue Jun 8 20:26:50 2010 UTC (14 years, 10 months ago) by chuckv
Content type:	text/plain
File size:	16320 byte(s)
Log Message:	Changes to gofrz so you can specify the z length
#	User	Rev	Content
1	gezelter	1390	/** @file StaticPropsCmd.h
2			* @brief The header file for the command line option parser
3			* generated by GNU Gengetopt version 2.22
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	310
8			#ifndef STATICPROPSCMD_H
9			#define STATICPROPSCMD_H
10
11			/* If we use autoconf. */
12			#ifdef HAVE_CONFIG_H
13			#include "config.h"
14			#endif
15
16	gezelter	1390	#include <stdio.h> /* for FILE */
17
18	tim	310	#ifdef __cplusplus
19			extern "C" {
20			#endif /* __cplusplus */
21
22			#ifndef CMDLINE_PARSER_PACKAGE
23	gezelter	1390	/** @brief the program name */
24	tim	311	#define CMDLINE_PARSER_PACKAGE "StaticProps"
25	tim	310	#endif
26
27			#ifndef CMDLINE_PARSER_VERSION
28	gezelter	1390	/** @brief the program version */
29	tim	310	#define CMDLINE_PARSER_VERSION "1.00"
30			#endif
31
32	gezelter	1390	/** @brief Where the command line options are stored */
33	tim	543	struct gengetopt_args_info
34			{
35	gezelter	1390	const char help_help; /< @brief Print help and exit help description. /
36			const char version_help; /< @brief Print version and exit help description. /
37			char * input_arg; /*< @brief input dump file. /
38			char * input_orig; /*< @brief input dump file original value given at command line. /
39			const char input_help; /< @brief input dump file help description. /
40			char * output_arg; /*< @brief output file name. /
41			char * output_orig; /*< @brief output file name original value given at command line. /
42			const char output_help; /< @brief output file name help description. /
43			int step_arg; /*< @brief process every n frame (default='1'). /
44			char * step_orig; /*< @brief process every n frame original value given at command line. /
45			const char step_help; /< @brief process every n frame help description. /
46			int nbins_arg; /*< @brief number of bins (general purpose) (default='100'). /
47			char * nbins_orig; /*< @brief number of bins (general purpose) original value given at command line. /
48			const char nbins_help; /< @brief number of bins (general purpose) help description. /
49			int nbins_x_arg; /*< @brief number of bins in x axis (default='100'). /
50			char * nbins_x_orig; /*< @brief number of bins in x axis original value given at command line. /
51			const char nbins_x_help; /< @brief number of bins in x axis help description. /
52			int nbins_y_arg; /*< @brief number of bins in y axis (default='100'). /
53			char * nbins_y_orig; /*< @brief number of bins in y axis original value given at command line. /
54			const char nbins_y_help; /< @brief number of bins in y axis help description. /
55	gezelter	1440	int nbins_z_arg; /*< @brief number of bins in z axis (default='100'). /
56			char * nbins_z_orig; /*< @brief number of bins in z axis original value given at command line. /
57			const char nbins_z_help; /< @brief number of bins in z axis help description. /
58	gezelter	1390	int nanglebins_arg; /*< @brief number of bins for cos(angle) (default='50'). /
59			char * nanglebins_orig; /*< @brief number of bins for cos(angle) original value given at command line. /
60			const char nanglebins_help; /< @brief number of bins for cos(angle) help description. /
61	chuckv	1445	double rcut_arg; /*< @brief cutoff radius (rcut). /
62			char * rcut_orig; /*< @brief cutoff radius (rcut) original value given at command line. /
63			const char rcut_help; /< @brief cutoff radius (rcut) help description. /
64	gezelter	1390	double length_arg; /*< @brief maximum length (Defaults to 1/2 smallest length of first frame). /
65			char * length_orig; /*< @brief maximum length (Defaults to 1/2 smallest length of first frame) original value given at command line. /
66			const char length_help; /< @brief maximum length (Defaults to 1/2 smallest length of first frame) help description. /
67	chuckv	1445	double zlength_arg; /*< @brief maximum length (Defaults to 1/2 smallest length of first frame). /
68			char * zlength_orig; /*< @brief maximum length (Defaults to 1/2 smallest length of first frame) original value given at command line. /
69			const char zlength_help; /< @brief maximum length (Defaults to 1/2 smallest length of first frame) help description. /
70	gezelter	1390	double zoffset_arg; /*< @brief Where to set the zero for the slab_density calculation (default='0'). /
71			char * zoffset_orig; /*< @brief Where to set the zero for the slab_density calculation original value given at command line. /
72			const char zoffset_help; /< @brief Where to set the zero for the slab_density calculation help description. /
73			char * sele1_arg; /*< @brief select the first stuntdouble set. /
74			char * sele1_orig; /*< @brief select the first stuntdouble set original value given at command line. /
75			const char sele1_help; /< @brief select the first stuntdouble set help description. /
76			char * sele2_arg; /*< @brief select the second stuntdouble set. /
77			char * sele2_orig; /*< @brief select the second stuntdouble set original value given at command line. /
78			const char sele2_help; /< @brief select the second stuntdouble set help description. /
79			char * sele3_arg; /*< @brief select the third stuntdouble set. /
80			char * sele3_orig; /*< @brief select the third stuntdouble set original value given at command line. /
81			const char sele3_help; /< @brief select the third stuntdouble set help description. /
82			char * refsele_arg; /*< @brief select reference (use and only use with --gxyz). /
83			char * refsele_orig; /*< @brief select reference (use and only use with --gxyz) original value given at command line. /
84			const char refsele_help; /< @brief select reference (use and only use with --gxyz) help description. /
85			char * comsele_arg; /*< @brief select stunt doubles for center-of-mass reference point. /
86			char * comsele_orig; /*< @brief select stunt doubles for center-of-mass reference point original value given at command line. /
87			const char comsele_help; /< @brief select stunt doubles for center-of-mass reference point help description. /
88			char * molname_arg; /*< @brief molecule name. /
89			char * molname_orig; /*< @brief molecule name original value given at command line. /
90			const char molname_help; /< @brief molecule name help description. /
91			int begin_arg; /*< @brief begin internal index. /
92			char * begin_orig; /*< @brief begin internal index original value given at command line. /
93			const char begin_help; /< @brief begin internal index help description. /
94			int end_arg; /*< @brief end internal index. /
95			char * end_orig; /*< @brief end internal index original value given at command line. /
96			const char end_help; /< @brief end internal index help description. /
97			double radius_arg; /*< @brief nanoparticle radius. /
98			char * radius_orig; /*< @brief nanoparticle radius original value given at command line. /
99			const char radius_help; /< @brief nanoparticle radius help description. /
100			const char bo_help; /< @brief bond order parameter (--rcut must be specified) help description. /
101			const char bor_help; /< @brief bond order parameter as a function of radius (--rcut must be specified) help description. /
102			const char bad_help; /< @brief N(theta) bond angle density within (--rcut must be specified) help description. /
103			const char gofr_help; /< @brief g(r) help description. /
104			const char gofz_help; /< @brief g(z) help description. /
105			const char r_theta_help; /< @brief g(r, cos(theta)) help description. /
106			const char r_omega_help; /< @brief g(r, cos(omega)) help description. /
107	gezelter	1440	const char r_z_help; /< @brief g(r, z) help description. /
108	gezelter	1390	const char theta_omega_help; /< @brief g(cos(theta), cos(omega)) help description. /
109			const char gxyz_help; /< @brief g(x, y, z) help description. /
110			const char p2_help; /< @brief p2 order parameter (--sele1 and --sele2 must be specified) help description. /
111			const char rp2_help; /< @brief rp2 order parameter (--sele1 and --sele2 must be specified) help description. /
112			const char scd_help; /< @brief scd order parameter (either --sele1, --sele2, --sele3 are specified or --molname, --begin, --end are specified) help description. /
113			const char density_help; /< @brief density plot help description. /
114			const char slab_density_help; /< @brief slab density help description. /
115	gezelter	1413	const char p_angle_help; /< @brief p(cos(theta)) help description. /
116	gezelter	1390	const char hxy_help; /< @brief hxy help description. /
117			const char rho_r_help; /< @brief rho of R help description. /
118			const char hullvol_help; /< @brief hull volume of nanoparticle help description. /
119	gezelter	929
120	gezelter	1390	unsigned int help_given ; /*< @brief Whether help was given. /
121			unsigned int version_given ; /*< @brief Whether version was given. /
122			unsigned int input_given ; /*< @brief Whether input was given. /
123			unsigned int output_given ; /*< @brief Whether output was given. /
124			unsigned int step_given ; /*< @brief Whether step was given. /
125			unsigned int nbins_given ; /*< @brief Whether nbins was given. /
126			unsigned int nbins_x_given ; /*< @brief Whether nbins_x was given. /
127			unsigned int nbins_y_given ; /*< @brief Whether nbins_y was given. /
128	gezelter	1440	unsigned int nbins_z_given ; /*< @brief Whether nbins_z was given. /
129	gezelter	1390	unsigned int nanglebins_given ; /*< @brief Whether nanglebins was given. /
130	chuckv	1445	unsigned int rcut_given ; /*< @brief Whether rcut was given. /
131	gezelter	1390	unsigned int length_given ; /*< @brief Whether length was given. /
132	chuckv	1445	unsigned int zlength_given ; /*< @brief Whether zlength was given. /
133	gezelter	1390	unsigned int zoffset_given ; /*< @brief Whether zoffset was given. /
134			unsigned int sele1_given ; /*< @brief Whether sele1 was given. /
135			unsigned int sele2_given ; /*< @brief Whether sele2 was given. /
136			unsigned int sele3_given ; /*< @brief Whether sele3 was given. /
137			unsigned int refsele_given ; /*< @brief Whether refsele was given. /
138			unsigned int comsele_given ; /*< @brief Whether comsele was given. /
139			unsigned int molname_given ; /*< @brief Whether molname was given. /
140			unsigned int begin_given ; /*< @brief Whether begin was given. /
141			unsigned int end_given ; /*< @brief Whether end was given. /
142			unsigned int radius_given ; /*< @brief Whether radius was given. /
143			unsigned int bo_given ; /*< @brief Whether bo was given. /
144			unsigned int bor_given ; /*< @brief Whether bor was given. /
145			unsigned int bad_given ; /*< @brief Whether bad was given. /
146			unsigned int gofr_given ; /*< @brief Whether gofr was given. /
147			unsigned int gofz_given ; /*< @brief Whether gofz was given. /
148			unsigned int r_theta_given ; /*< @brief Whether r_theta was given. /
149			unsigned int r_omega_given ; /*< @brief Whether r_omega was given. /
150	gezelter	1440	unsigned int r_z_given ; /*< @brief Whether r_z was given. /
151	gezelter	1390	unsigned int theta_omega_given ; /*< @brief Whether theta_omega was given. /
152			unsigned int gxyz_given ; /*< @brief Whether gxyz was given. /
153			unsigned int p2_given ; /*< @brief Whether p2 was given. /
154			unsigned int rp2_given ; /*< @brief Whether rp2 was given. /
155			unsigned int scd_given ; /*< @brief Whether scd was given. /
156			unsigned int density_given ; /*< @brief Whether density was given. /
157			unsigned int slab_density_given ; /*< @brief Whether slab_density was given. /
158	gezelter	1413	unsigned int p_angle_given ; /*< @brief Whether p_angle was given. /
159	gezelter	1390	unsigned int hxy_given ; /*< @brief Whether hxy was given. /
160			unsigned int rho_r_given ; /*< @brief Whether rho_r was given. /
161			unsigned int hullvol_given ; /*< @brief Whether hullvol was given. /
162	tim	310
163	gezelter	1390	int staticProps_group_counter; /*< @brief Counter for group staticProps /
164	tim	543	} ;
165	tim	310
166	gezelter	1390	/** @brief The additional parameters to pass to parser functions */
167			struct cmdline_parser_params
168			{
169			int override; /*< @brief whether to override possibly already present options (default 0) /
170			int initialize; /*< @brief whether to initialize the option structure gengetopt_args_info (default 1) /
171			int check_required; /*< @brief whether to check that all required options were provided (default 1) /
172			int check_ambiguity; /*< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) /
173			int print_errors; /*< @brief whether getopt_long should print an error message for a bad option (default 1) /
174			} ;
175
176			/** @brief the purpose string of the program */
177	chuckv	1128	extern const char *gengetopt_args_info_purpose;
178	gezelter	1390	/** @brief the usage string of the program */
179	chuckv	1128	extern const char *gengetopt_args_info_usage;
180	gezelter	1390	/** @brief all the lines making the help output */
181	chuckv	1128	extern const char *gengetopt_args_info_help[];
182	tim	310
183	gezelter	1390	/**
184			* The command line parser
185			* @param argc the number of command line options
186			* @param argv the command line options
187			* @param args_info the structure where option information will be stored
188			* @return 0 if everything went fine, NON 0 if an error took place
189			*/
190	chuckv	1128	int cmdline_parser (int argc, char * const *argv,
191			struct gengetopt_args_info *args_info);
192	gezelter	1390
193			/**
194			* The command line parser (version with additional parameters - deprecated)
195			* @param argc the number of command line options
196			* @param argv the command line options
197			* @param args_info the structure where option information will be stored
198			* @param override whether to override possibly already present options
199			* @param initialize whether to initialize the option structure my_args_info
200			* @param check_required whether to check that all required options were provided
201			* @return 0 if everything went fine, NON 0 if an error took place
202			* @deprecated use cmdline_parser_ext() instead
203			*/
204	chuckv	1128	int cmdline_parser2 (int argc, char * const *argv,
205			struct gengetopt_args_info *args_info,
206			int override, int initialize, int check_required);
207	gezelter	1390
208			/**
209			* The command line parser (version with additional parameters)
210			* @param argc the number of command line options
211			* @param argv the command line options
212			* @param args_info the structure where option information will be stored
213			* @param params additional parameters for the parser
214			* @return 0 if everything went fine, NON 0 if an error took place
215			*/
216			int cmdline_parser_ext (int argc, char * const *argv,
217			struct gengetopt_args_info *args_info,
218			struct cmdline_parser_params *params);
219
220			/**
221			* Save the contents of the option struct into an already open FILE stream.
222			* @param outfile the stream where to dump options
223			* @param args_info the option struct to dump
224			* @return 0 if everything went fine, NON 0 if an error took place
225			*/
226			int cmdline_parser_dump(FILE *outfile,
227			struct gengetopt_args_info *args_info);
228
229			/**
230			* Save the contents of the option struct into a (text) file.
231			* This file can be read by the config file parser (if generated by gengetopt)
232			* @param filename the file where to save
233			* @param args_info the option struct to save
234			* @return 0 if everything went fine, NON 0 if an error took place
235			*/
236	chuckv	1128	int cmdline_parser_file_save(const char *filename,
237			struct gengetopt_args_info *args_info);
238
239	gezelter	1390	/**
240			* Print the help
241			*/
242	tim	543	void cmdline_parser_print_help(void);
243	gezelter	1390	/**
244			* Print the version
245			*/
246	tim	543	void cmdline_parser_print_version(void);
247	tim	310
248	gezelter	1390	/**
249			* Initializes all the fields a cmdline_parser_params structure
250			* to their default values
251			* @param params the structure to initialize
252			*/
253			void cmdline_parser_params_init(struct cmdline_parser_params *params);
254
255			/**
256			* Allocates dynamically a cmdline_parser_params structure and initializes
257			* all its fields to their default values
258			* @return the created and initialized cmdline_parser_params structure
259			*/
260			struct cmdline_parser_params *cmdline_parser_params_create(void);
261
262			/**
263			* Initializes the passed gengetopt_args_info structure's fields
264			* (also set default values for options that have a default)
265			* @param args_info the structure to initialize
266			*/
267	gezelter	929	void cmdline_parser_init (struct gengetopt_args_info *args_info);
268	gezelter	1390	/**
269			* Deallocates the string fields of the gengetopt_args_info structure
270			* (but does not deallocate the structure itself)
271			* @param args_info the structure to deallocate
272			*/
273	gezelter	929	void cmdline_parser_free (struct gengetopt_args_info *args_info);
274
275	gezelter	1390	/**
276			* Checks that all the required options were specified
277			* @param args_info the structure to check
278			* @param prog_name the name of the program that will be used to print
279			* possible errors
280			* @return
281			*/
282	chuckv	1128	int cmdline_parser_required (struct gengetopt_args_info *args_info,
283			const char *prog_name);
284	gezelter	929
285
286	tim	310	#ifdef __cplusplus
287			}
288			#endif /* __cplusplus */
289			#endif /* STATICPROPSCMD_H */