NSCL DDAS  1.0
Support for XIA DDAS at the NSCL
 All Classes Namespaces Files Functions Variables Macros Pages
tosetfile.h
Go to the documentation of this file.
1 
8 #ifndef TOSETFILE_H
9 #define TOSETFILE_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 
24 #define CMDLINE_PARSER_PACKAGE "ToSetfile"
25 #endif
26 
27 #ifndef CMDLINE_PARSER_PACKAGE_NAME
28 
29 #define CMDLINE_PARSER_PACKAGE_NAME "ToSetfile"
30 #endif
31 
32 #ifndef CMDLINE_PARSER_VERSION
33 
34 #define CMDLINE_PARSER_VERSION "1.0"
35 #endif
36 
39 {
40  const char *help_help;
41  const char *version_help;
42  char * xml_arg;
43  char * xml_orig;
44  const char *xml_help;
45  char * setfile_arg;
46  char * setfile_orig;
47  const char *setfile_help;
48  char ** msps_arg;
49  char ** msps_orig;
50  unsigned int msps_min;
51  unsigned int msps_max;
52  const char *msps_help;
54  unsigned int help_given ;
55  unsigned int version_given ;
56  unsigned int xml_given ;
57  unsigned int setfile_given ;
58  unsigned int msps_given ;
60 } ;
61 
64 {
65  int override;
66  int initialize;
67  int check_required;
68  int check_ambiguity;
69  int print_errors;
70 } ;
71 
73 extern const char *gengetopt_args_info_purpose;
75 extern const char *gengetopt_args_info_usage;
77 extern const char *gengetopt_args_info_description;
79 extern const char *gengetopt_args_info_help[];
80 
88 int cmdline_parser (int argc, char **argv,
89  struct gengetopt_args_info *args_info);
90 
102 int cmdline_parser2 (int argc, char **argv,
103  struct gengetopt_args_info *args_info,
104  int override, int initialize, int check_required);
105 
114 int cmdline_parser_ext (int argc, char **argv,
115  struct gengetopt_args_info *args_info,
116  struct cmdline_parser_params *params);
117 
124 int cmdline_parser_dump(FILE *outfile,
125  struct gengetopt_args_info *args_info);
126 
134 int cmdline_parser_file_save(const char *filename,
135  struct gengetopt_args_info *args_info);
136 
140 void cmdline_parser_print_help(void);
145 
152 
159 
165 void cmdline_parser_init (struct gengetopt_args_info *args_info);
171 void cmdline_parser_free (struct gengetopt_args_info *args_info);
172 
180 int cmdline_parser_required (struct gengetopt_args_info *args_info,
181  const char *prog_name);
182 
183 
184 #ifdef __cplusplus
185 }
186 #endif /* __cplusplus */
187 #endif /* TOSETFILE_H */
const char * msps_help
Speed specification of a digitizer (slot:mhz) default is 250MHz help description. ...
Definition: tocrate.h:64
int initialize
whether to initialize the option structure gengetopt_args_info (default 1)
Definition: dumperargs.h:79
void cmdline_parser_params_init(struct cmdline_parser_params *params)
Definition: dumperargs.cpp:163
Where the command line options are stored.
Definition: dumperargs.h:38
void cmdline_parser_print_help(void)
Definition: dumperargs.cpp:146
unsigned int help_given
Whether help was given.
Definition: dumperargs.h:63
char * setfile_arg
Path to output Set file.
Definition: tosetfile.h:45
char * setfile_orig
Path to output Set file original value given at command line.
Definition: tosetfile.h:46
unsigned int msps_given
Whether msps was given.
Definition: tocrate.h:73
int cmdline_parser2(int argc, char **argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required)
Definition: dumperargs.cpp:327
int cmdline_parser_dump(FILE *outfile, struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:229
char ** msps_orig
Speed specification of a digitizer (slot:mhz) default is 250MHz original value given at command line...
Definition: tocrate.h:61
char * xml_arg
Path to XML Crate definition file.
Definition: tosetfile.h:42
The additional parameters to pass to parser functions.
Definition: dumperargs.h:76
int cmdline_parser_file_save(const char *filename, struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:264
const char * version_help
Print version and exit help description.
Definition: dumperargs.h:41
unsigned int msps_min
Speed specification of a digitizer (slot:mhz) default is 250MHz's minimum occurreces.
Definition: tocrate.h:62
const char * gengetopt_args_info_usage
the usage string of the program
Definition: dumperargs.cpp:30
const char * xml_help
Path to XML Crate definition file help description.
Definition: tosetfile.h:44
struct cmdline_parser_params * cmdline_parser_params_create(void)
Definition: dumperargs.cpp:176
void cmdline_parser_print_version(void)
Definition: dumperargs.cpp:120
unsigned int setfile_given
Whether setfile was given.
Definition: tosetfile.h:57
const char * gengetopt_args_info_purpose
the purpose string of the program
Definition: dumperargs.cpp:28
int cmdline_parser(int argc, char **argv, struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:305
const char * help_help
Print help and exit help description.
Definition: dumperargs.h:40
const char * setfile_help
Path to output Set file help description.
Definition: tosetfile.h:47
void cmdline_parser_free(struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:284
void cmdline_parser_init(struct gengetopt_args_info *args_info)
Definition: dumperargs.cpp:155
const char * gengetopt_args_info_help[]
all the lines making the help output
Definition: dumperargs.cpp:36
char * xml_orig
Path to XML Crate definition file original value given at command line.
Definition: tosetfile.h:43
int print_errors
whether getopt_long should print an error message for a bad option (default 1)
Definition: dumperargs.h:82
int cmdline_parser_ext(int argc, char **argv, struct gengetopt_args_info *args_info, struct cmdline_parser_params *params)
Definition: dumperargs.cpp:311
int check_ambiguity
whether to check for options already specified in the option structure gengetopt_args_info (default 0...
Definition: dumperargs.h:81
int check_required
whether to check that all required options were provided (default 1)
Definition: dumperargs.h:80
unsigned int msps_max
Speed specification of a digitizer (slot:mhz) default is 250MHz's maximum occurreces.
Definition: tocrate.h:63
char ** msps_arg
Speed specification of a digitizer (slot:mhz) default is 250MHz.
Definition: tocrate.h:60
const char * gengetopt_args_info_description
the description string of the program
Definition: dumperargs.cpp:34
unsigned int xml_given
Whether xml was given.
Definition: tosetfile.h:56
int cmdline_parser_required(struct gengetopt_args_info *args_info, const char *prog_name)
Definition: dumperargs.cpp:350
unsigned int version_given
Whether version was given.
Definition: dumperargs.h:64