HPS-MC
 
Loading...
Searching...
No Matches
LCIOTool Class Reference

Generic component for LCIO tools. More...

Inheritance diagram for LCIOTool:
Component LCIOConcat LCIOCount LCIOMerge

Public Member Functions

 __init__ (self, name=None, **kwargs)
 
 config (self, parser)
 Configure LCIOTool component.
 
 cmd_args (self)
 Setup command arguments.
 
 required_config (self)
 Return list of required config.
 
 required_parameters (self)
 Return list of required parameters.
 
- 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.
 
 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

 lcio_bin_jar
 lcio bin jar (whatever this is)
 
- 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.
 

Detailed Description

Generic component for LCIO tools.

Required parameters are: none
Required config are: lcio_bin_jar

Definition at line 1411 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
  name = None,
**  kwargs 
)

Reimplemented from Component.

Reimplemented in LCIOConcat, LCIOCount, and LCIOMerge.

Definition at line 1419 of file tools.py.

Member Function Documentation

◆ cmd_args()

cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from Component.

Reimplemented in LCIOConcat, LCIOCount, and LCIOMerge.

Definition at line 1433 of file tools.py.

◆ config()

config (   self,
  parser 
)

Configure LCIOTool component.

Reimplemented from Component.

Definition at line 1427 of file tools.py.

◆ required_config()

required_config (   self)

Return list of required config.

Required config are: lcio_bin_jar

Returns
list of required config

Reimplemented from Component.

Definition at line 1442 of file tools.py.

◆ required_parameters()

required_parameters (   self)

Return list of required parameters.

Required parameters are: none

Returns
list of required parameters

Reimplemented from Component.

Reimplemented in LCIOCount.

Definition at line 1451 of file tools.py.

Member Data Documentation

◆ lcio_bin_jar

lcio_bin_jar

lcio bin jar (whatever this is)

Definition at line 1421 of file tools.py.


The documentation for this class was generated from the following file: