HPS-MC
JavaTool Class Reference

Generic base class for Java based tools. More...

Inheritance diagram for JavaTool:
Component EvioToLcio ExtractEventsWithHitAtHodoEcal FilterBunches

Public Member Functions

def __init__ (self, name, java_class, **kwargs)
 
def required_config (self)
 Return list of required config. More...
 
def cmd_args (self)
 Setup command arguments. More...
 
def config (self, parser)
 Automatic configuration. More...
 
- Public Member Functions inherited from Component
def __init__ (self, name, command=None, nevents=None, seed=1, inputs=[], outputs=None, append_tok=None, output_ext=None, ignore_job_params=[], **kwargs)
 
def cmd_line_str (self)
 
def execute (self, log_out=sys.stdout, log_err=sys.stderr)
 Generic component execution method. More...
 
def cmd_exists (self)
 Check if the component's assigned command exists. More...
 
def cmd_args_str (self)
 Return list of arguments, making sure they are all converted to strings. More...
 
def setup (self)
 Perform any necessary setup for this component to run such as making symlinks to required directories. More...
 
def cleanup (self)
 Perform post-job cleanup such as deleting temporary files. More...
 
def config_logging (self, parser)
 Configure the logging for a component. More...
 
def set_parameters (self, params)
 Set class attributes for the component based on JSON parameters. More...
 
def required_parameters (self)
 Return a list of required parameters. More...
 
def optional_parameters (self)
 Return a list of optional parameters. More...
 
def check_config (self)
 Raise an exception on the first missing config setting for this component. More...
 
def input_files (self)
 Get a list of input files for this component. More...
 
def output_files (self)
 Return a list of output files created by this component. More...
 
def 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. More...
 

Public Attributes

 java_class
 java class More...
 
 java_args
 java arguments More...
 
 conditions_url
 tbd More...
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Detailed Description

Generic base class for Java based tools.

Definition at line 910 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  name,
  java_class,
**  kwargs 
)

Definition at line 915 of file tools.py.

Member Function Documentation

◆ cmd_args()

def cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from Component.

Reimplemented in ExtractEventsWithHitAtHodoEcal, FilterBunches, and EvioToLcio.

Definition at line 936 of file tools.py.

◆ config()

def 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.

   @param parser  config parser

Reimplemented from Component.

Reimplemented in FilterBunches.

Definition at line 953 of file tools.py.

◆ required_config()

def required_config (   self)

Return list of required config.

Required config are: hps_java_bin_jar

Returns
list of required config

Reimplemented from Component.

Reimplemented in FilterBunches.

Definition at line 927 of file tools.py.

Member Data Documentation

◆ conditions_url

conditions_url

tbd

Definition at line 921 of file tools.py.

◆ java_args

java_args

java arguments

Definition at line 919 of file tools.py.

◆ java_class

java_class

java class

Definition at line 917 of file tools.py.


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