This class does very little by itself.
However, it provides an environment convenient for doing a
discrete stage of processing, which child classes may inherit.
Constructor
- new(option1,option2...)
The options are read and stored so that child classes may use them.
Typically the constructor will be invoked with no arguments.
Accessors
- log()
The log object.
- procpar()
Parfile for the processing script.
- jobpar()
Sequence-specific parfile object.
- filename()
Filename generator object.
- proctop()
The top level directory for the mission specific code.
- comtop()
The top level directory for the mission independant code.
- script()
Name of the processing script.
- option(option)
- name()
Return a unique name for this subroutine.
Methods
- check_commands()
Check the proc_command and proc_status job.par parameters
to see if we need to do anything special like stop or resume
This method returns true if we should not continue on to run the
subroutine.
- temp_file(tag)
Returns the name of a temporary file whose name is based on the given string.
The file name is guaranteed to be unique. In other words, there will be
no existing files with the returned name at the time this method is called.
The object keeps track of the temporary file names and deletes them
in the cleanup phase.
- init()
Do initialization before running the body method.
Puts a "milestone" entry in the log.
- cleanup()
Do any necessary cleanup after running the body method.
This method doesn't do much, but it may be
overridden by sub-classes.
- body()
This is the method which does all the work. For this general
class it does nothing, but it is intended to be overridden
in sub-classes.
- run()
This method should be invoked to run the subroutine. It calls
the init, body, and cleanup methods in that order.
Special Methods
- BEGIN()
This function called when the Sub module is compiled.
It initializes the class data and sets up the processing environment.