Util::ParfileTool (version 1.2)

Parent Class: Util::Tool

Constructor

• new()
  This constructor should be called by subclass constructors after sufficient initialization has been done so that the bins and syspfiles methods methods will work.

Accessors

• syspfiles()
  Return the directory containing the "system" parfiles.

• libs()
  Return all shared object library directories for this software package These will be prepended to LD_LIBRARY_PATH when the tool is run.

• bins()
  Return all executable directories for this software package These will be prepended to PATH when the tool is run.

• environment()
  Returns a hash of environment variables which must be set before running this tool.

• is_script()
  Set the flag indicating whether this is a script.

• parfile()
  Get or set the Util::Parfile object for the parameter file. This can be used to read values which the program wrote to the parfile. Note the parfile is deleted when this object is destroyed so you may need to explicitly call DESTROY() so that it will stick around long enough to be read.

• params(params)
  Set the FTOOL input parameters. Note the parameters are given as a reference to a hash.

• find_bin(file)
  Find a file in one of the bin directories.

• init()
  Special initialization - set the parameters in the parfile.

• cleanup()
  

• error()
  Override the generic tool error routine to also dump the parfile to the log if it exists.

Methods

Special Methods

• DESTROY()
  Destructor - deletes the parfile.