HPS-MC
DummyComponent Class Reference

A dummy component that just prints some information instead of executing a program. More...

Inheritance diagram for DummyComponent:
Component

Public Member Functions

def __init__ (self, **kwargs)
 
def execute (self, log_out=sys.stdout, log_err=sys.stderr)
 Generic component execution method. 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 cmd_exists (self)
 Check if the component's assigned command exists. More...
 
def cmd_args (self)
 Return the command arguments of this component. 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 config (self, parser)
 Automatic configuration. 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 required_config (self)
 Return a list of required configuration settings. 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...
 

Additional Inherited Members

- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 

Detailed Description

A dummy component that just prints some information instead of executing a program.

Definition at line 243 of file component.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
**  kwargs 
)

Definition at line 246 of file component.py.

Member Function Documentation

◆ execute()

def execute (   self,
  log_out = sys.stdout,
  log_err = sys.stderr 
)

Generic component execution method.

   Individual components may override this if specific behavior is required.

   @param log_out  name of log file for output
   @param log_err  name of log file for error
   @return error code

Reimplemented from Component.

Definition at line 249 of file component.py.


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