User's Guide

STOPFUNC

Create stop files for the specified functions

Function:

Create stop files for the specified functions. Create a stop file for each of the specified functions in the ADAPSTABLES directory. All specified functions (including those having more than one occurrence of the function running) will stop at the next convenient time (after a transfer is complete, ...).

Parameters:

FUNCNAM(ALL)
Function name. The ADAPS processing function(s) to stop. The default is to stop all ADAPS functions except AVHRRSTACK (see User Notes). Refer to $ADAPSTABLES/adapstop.ppf for a list of valid functions (do a 'more' on this file, or run GETPARM on this file).

Examples:

  1. LAS> stopfunc funcnam=bwtrans

    A stop file for the BWTRANS function will be created in the ADAPSTABLES directory. It will signal BWTRANS to stop processing at the next convenient time.

  2. LAS> stopfunc

    A stop file will be created, in the ADAPSTABLES directory, for each of the valid ADAPS functions. The stop files signals each of the functions to stop processing at the next convenient time. The function AVHRRSTACK will not be stopped (see User Notes).

Description/Algorithm:

Create a stop file in the ADAPSTABLES directory for the specified FUNCNAM(s). When the stop file "FUNCNAM;stop" exists, all versions of the specified function will stop at the next convenient time.

Nonfatal Error Messages:

    None.

Fatal Error Messages:

  1. [stopfunc-fatal] Fatal error encountered

    A fatal error was encountered. The message that is displayed preceding this message is the error that was encountered.

User Notes:

  1. STOPFUNC is used to stop batch or continually running functions. A stop file is created for each specified function in the ADAPSTABLES directory. Each function will check for a stop file in the ADAPSTABLES directory and stop processing at a convenient time (after an orbit is stitched, after a transfer is completed, ...). See the user's guides for each function to determine what constitutes a convenient time.

  2. STOPFUNC or the specified function(s) do not remove the stop file(s) when completed. ADAPSTOP runs STOPFUNC and CKQUE to create the stop file(s), monitor the batch queues for the specified function(s), and remove the stop file(s). The user is responsible for removing the stop file(s) in ADAPSTABLES when STOPFUNC is run stand-alone.

  3. STOPFUNC does not create stop files for AVHRRSTACK functions. These require unique parameters to identify the correct function to stop. Use STOPSTACK to create stop files for AVHRRSTACK.

  4. No checks are made to determine if the user running STOPFUNC is the same as the user running the function to be stopped. If the ADAPSTABLES directory has write permission for a user, they are able to stop any function.

  5. The stop file is a TAE parameter file that contains the stop file name and the name of the function that is to be stopped.