This page was created by the IDL library routine `mk_html_help2`.

Last modified: Tue Aug 5 18:17:40 2025.

# Directory Listing of Routines

# spedas_gui/api_examples/file_configuration_tab

- SPD_UI_YYY_FILECONFIG
  A widget that allows the user to set some of the !yyy environmental variables. The user
- YYY_CONFIG_FILEDIR
- YYY_INIT
  Initializes system variables for yyy data. Can be called from idl_startup to set
- YYY_READ_CONFIG
  Reads the plug-in configuration file (yyy_config.txt). Feel free to copy+paste
- YYY_WRITE_CONFIG
  Writes the yyy_config file

# Routine Descriptions

## SPD_UI_YYY_FILECONFIG

[Next Routine] [List of Routines]

    NAME:
     spd_ui_yyy_fileconfig

    PURPOSE:
     A widget that allows the user to set some of the !yyy environmental variables. The user
     can save the changes permanently to file, reset to default values, or cancel any changes
     made since the panel was displayed.

    HISTORY:

    $LastChangedBy: jimm $
    $LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $
    $LastChangedRevision: 14326 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/api_examples/file_configuration_tab/spd_ui_yyy_fileconfig.pro $

(See spedas_gui/api_examples/file_configuration_tab/spd_ui_yyy_fileconfig.pro)

## YYY_CONFIG_FILEDIR

[Previous Routine] [Next Routine] [List of Routines]

    Function: yyy_config_filedir.pro
    Purpose: Get the applications user directory for SPEDAS data analysis software

    $LastChangedBy: jimm $
    $LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $
    $LastChangedRevision: 14326 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/api_examples/file_configuration_tab/yyy_config_filedir.pro $

(See spedas_gui/api_examples/file_configuration_tab/yyy_config_filedir.pro)

## YYY_INIT

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
       yyy_init

     PURPOSE:
       Initializes system variables for yyy data. Can be called from idl_startup to set
                custom locations.

    $LastChangedBy: egrimes $
    $LastChangedDate: 2018-05-13 14:10:12 -0700 (Sun, 13 May 2018) $
    $LastChangedRevision: 25206 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/api_examples/file_configuration_tab/yyy_init.pro $

(See spedas_gui/api_examples/file_configuration_tab/yyy_init.pro)

## YYY_READ_CONFIG

[Previous Routine] [Next Routine] [List of Routines]

     NAME:
       yyy_read_config

     PURPOSE:
       Reads the plug-in configuration file (yyy_config.txt). Feel free to copy+paste
       this for your new plug-in, and change 'yyy' to your mission acronym throughout

     CALLING SEQUENCE:
       cstruct = yyy_read_config()

     INPUT:
       none, for the purposes of this example the filename is hardcoded,
       'yyy_config.txt', and is put in a folder given by the routine
       istp_config_filedir, that uses the IDL
       routine app_user_dir to create/obtain it: my linux example:
       /disks/ice/home/jimm/.idl/spedas/yyy_config-4-linux

     OUTPUT:
       cstruct = a structure with the changeable fields of the !istp
               structure

     HISTORY:
       Cleaned up for new plug-ins by egrimes 14-may-2018
       Copied from thm_read_config and tt2000_read_config lphilpott 20-jun-2012

    $LastChangedBy: egrimes $
    $LastChangedDate: 2018-05-14 16:49:20 -0700 (Mon, 14 May 2018) $
    $LastChangedRevision: 25221 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/api_examples/file_configuration_tab/yyy_read_config.pro $

(See spedas_gui/api_examples/file_configuration_tab/yyy_read_config.pro)

## YYY_WRITE_CONFIG

[Previous Routine] [List of Routines]

    NAME:
     yyy_write_config
    PURPOSE:
     Writes the yyy_config file
    CALLING SEQUENCE:
     yyy_write_config, copy=copy
    INPUT:
     none, the filename is hardcoded, 'yyy_config.txt',and is  put in a
     folder given by the routine yyy_config_filedir, that uses the IDL
     routine app_user_dir to create/obtain it: my linux example:
     /disks/ice/home/jimm/.idl/spedas/yyy_config-4-linux
    OUTPUT:
     the file is written, and a copy of any old file is generated
    KEYWORD:
     copy = if set, the file is read in and a copy with the !stime
            appended is written out
    HISTORY:
     Copied from tt2000_write_config and thm_write_config lphilpott 20-jun-2012
    $LastChangedBy: egrimes $
    $LastChangedDate: 2015-03-20 13:50:13 -0700 (Fri, 20 Mar 2015) $
    $LastChangedRevision: 17158 $
    $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas_gui/api_examples/file_configuration_tab/yyy_write_config.pro $

(See spedas_gui/api_examples/file_configuration_tab/yyy_write_config.pro)