|
HPS-MC
|
|
|
HPS-MC
|
|
Generic base class for Java based tools. More...
Public Member Functions | |
| __init__ (self, name, java_class, **kwargs) | |
| required_config (self) | |
| Return list of required config. | |
| cmd_args (self) | |
| Setup command arguments. | |
| config (self, parser) | |
| Automatic configuration. | |
 Public Member Functions inherited from Component | |
| cmd_line_str (self) | |
| execute (self, log_out=sys.stdout, log_err=sys.stderr) | |
| Generic component execution method. | |
| cmd_exists (self) | |
| Check if the component's assigned command exists. | |
| cmd_args_str (self) | |
| Return list of arguments, making sure they are all converted to strings. | |
| setup (self) | |
| Perform any necessary setup for this component to run such as making symlinks to required directories. | |
| cleanup (self) | |
| Perform post-job cleanup such as deleting temporary files. | |
| config_logging (self, parser) | |
| Configure the logging for a component. | |
| set_parameters (self, params) | |
| Set class attributes for the component based on JSON parameters. | |
| required_parameters (self) | |
| Return a list of required parameters. | |
| optional_parameters (self) | |
| Return a list of optional parameters. | |
| check_config (self) | |
| Raise an exception on the first missing config setting for this component. | |
| input_files (self) | |
| Get a list of input files for this component. | |
| output_files (self) | |
| Return a list of output files created by this component. | |
| config_from_environ (self) | |
| Configure component from environment variables which are just upper case versions of the required config names set in the shell environment. | |
Public Attributes | |
| java_class | |
| java class | |
| java_args | |
| java arguments | |
| conditions_url | |
| tbd | |
| hps_java_bin_jar | |
| Public Attributes inherited from Component | |
| name | |
| command | |
| nevents | |
| seed | |
| inputs | |
| outputs | |
| append_tok | |
| output_ext | |
| ignore_job_params | |
| hpsmc_dir | |
| logger | |
Additional Inherited Members | |
| Protected Member Functions inherited from Component | |
| _inputs_to_outputs (self) | |
| This is the default method for automatically transforming input file names to outputs when output file names are not explicitly provided. | |
| __init__ | ( | self, | |
| name, | |||
| java_class, | |||
| ** | kwargs | ||
| ) |
Reimplemented from Component.
Reimplemented in FilterBunches, ExtractEventsWithHitAtHodoEcal, and EvioToLcio.
| cmd_args | ( | self | ) |
Setup command arguments.
Reimplemented from Component.
Reimplemented in EvioToLcio, FilterBunches, and ExtractEventsWithHitAtHodoEcal.
| config | ( | self, | |
| parser | |||
| ) |
Automatic configuration.
Automatically load attributes from config by reading in values from the section with the same name as the class in the config file and assigning them to class attributes with the same name.
| parser | config parser |
Reimplemented from Component.
Reimplemented in FilterBunches.
| required_config | ( | self | ) |
Return list of required config.
Required config are: hps_java_bin_jar
Reimplemented from Component.
Reimplemented in FilterBunches.
1.9.8