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

Tar files into an archive. More...

Inheritance diagram for TarFiles:
Component

Public Member Functions

 __init__ (self, **kwargs)
 
 cmd_exists (self)
 Check if command exists.
 
 execute (self, log_out, log_err)
 Execute TarFiles component.
 
- Public Member Functions inherited from Component
 cmd_line_str (self)
 
 cmd_args (self)
 Return the command arguments of this component.
 
 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.
 
 config (self, parser)
 Automatic configuration.
 
 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.
 
 required_config (self)
 Return a list of required configuration settings.
 
 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.
 

Additional Inherited Members

- Public Attributes inherited from Component
 name
 
 command
 
 nevents
 
 seed
 
 inputs
 
 outputs
 
 append_tok
 
 output_ext
 
 ignore_job_params
 
 hpsmc_dir
 
 logger
 
- 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

Tar files into an archive.

Definition at line 1353 of file tools.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self,
**  kwargs 
)

Reimplemented from Component.

Definition at line 1358 of file tools.py.

Member Function Documentation

◆ cmd_exists()

cmd_exists (   self)

Check if command exists.

Returns
True if command exists

Reimplemented from Component.

Definition at line 1363 of file tools.py.

◆ execute()

execute (   self,
  log_out,
  log_err 
)

Execute TarFiles component.

Reimplemented from Component.

Definition at line 1370 of file tools.py.


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