HPS-MC
LCIODumpEvent Class Reference

Dump LCIO event information. More...

Inheritance diagram for LCIODumpEvent:
Component

Public Member Functions

def __init__ (self, **kwargs)
 
def config (self, parser)
 Configure LCIODumpEvent component. More...
 
def setup (self)
 Setup LCIODumpEvent component. More...
 
def cmd_args (self)
 Setup command arguments. More...
 
def required_config (self)
 Return list of required config. More...
 
def required_parameters (self)
 Return list of required parameters. 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 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 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

 lcio_dir
 lcio directory More...
 
 event_num
 
 command
 
- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Detailed Description

Dump LCIO event information.

Required parameters are: none
Required config are: lcio_dir

Definition at line 1246 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
**  kwargs 
)

Definition at line 1254 of file tools.py.

Member Function Documentation

◆ cmd_args()

def cmd_args (   self)

Setup command arguments.

Returns
list of arguments

Reimplemented from Component.

Definition at line 1277 of file tools.py.

◆ config()

def config (   self,
  parser 
)

Configure LCIODumpEvent component.

Reimplemented from Component.

Definition at line 1267 of file tools.py.

◆ required_config()

def required_config (   self)

Return list of required config.

Required config are: lcio_dir

Returns
list of required config

Reimplemented from Component.

Definition at line 1289 of file tools.py.

◆ required_parameters()

def required_parameters (   self)

Return list of required parameters.

Required parameters are: none

Returns
list of required parameters

Reimplemented from Component.

Definition at line 1298 of file tools.py.

◆ setup()

def setup (   self)

Setup LCIODumpEvent component.

Reimplemented from Component.

Definition at line 1273 of file tools.py.

Member Data Documentation

◆ command

command

Definition at line 1275 of file tools.py.

◆ event_num

event_num

Definition at line 1263 of file tools.py.

◆ lcio_dir

lcio_dir

lcio directory

Definition at line 1256 of file tools.py.


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