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

Last modified: Sat Jul 26 18:17:38 2025.

# Directory Listing of Routines

# projects/cluster/spedas_plugin

- CL_CSA_UI_LOAD_DATA
  This routine builds a load data panel of widgets for the Cluster mission and
- CL_CSA_UI_LOAD_DATA_LOAD_PRO
  This routine provides an example for loading data into the GUI from the load
- CL_UI_LOAD_DATA
  This routine builds a load data panel of widgets for the Cluster mission and
- CL_UI_LOAD_DATA_LOAD_PRO
  This routine provides an example for loading data into the GUI from the load

# Routine Descriptions

## CL_CSA_UI_LOAD_DATA

[Next Routine] [List of Routines]

    NAME:
      cl_csa_ui_load_data

    PURPOSE:
      This routine builds a load data panel of widgets for the Cluster mission and
      handles the widget events produces.

    HISTORY:
    $LastChangedBy: jimm $
    $LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $
    $LastChangedRevision: 14326 $

(See projects/cluster/spedas_plugin/cl_csa_ui_load_data.pro)

## CL_CSA_UI_LOAD_DATA_LOAD_PRO

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

    NAME:
      cl_csa_ui_load_data_load_pro

    PURPOSE:
      This routine provides an example for loading data into the GUI from the load
      data panel. The purpose of this routine is to provide a wrapper around the
      actual load data procedure (which is mission specific). This routine handles
      all the 'administrative' work of validating times, checking if data exists,
      and adding the data to the GUI's loadedData object. The loadedData object
      loads and tracks all data that is available to the GUI.

     INPUT:
      loadStruc - this structure contains all the mission specific information that
                  is required by the procedure that loads the data.
                  For purposes of demonstration, this rouine uses the following
                  parameters:
                  probe - ['C1','C2','C3','C4']
                  datatype - character string (or array) specifying the data types to pass to the CSA
                     web service
                  time range - an array of 2 character strings containing the
                               start and stop times of the data to be loaded.
                               ['2007-03-23/00:00:00', '2007-03-24/00:00:00']
      loadedData - the loaded data object contains information on all variables
                   currently loaded in the gui. This object is used by many other
                   panels to display the variables that are available to the GUI.
                   Whenever new data is imported to the GUI this object must be
                   updated.
      statusBar - the status bar object used to display textual information
                  for the user and is located at the bottom of the load windows.
                  This object can be used to inform the user of successful
                  executions, warnings, and/or errors.
      historyWin - the history window object displays all messages generated
                   during this session.
      parent_widget_id - the widget ID of the parent. This ID is needed for
                         appropriate layering and modality of popups

      KEYWORDS (OPTIONAL):
      replay - set this flag to replay previous dproc operations
      overwrite - this flag allows the replay of user overwrites

    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/tags/spedas_1_00/spedas/gui/api_examples/load_data_tab/cl_csa_ui_load_data_load_pro.pro $

(See projects/cluster/spedas_plugin/cl_csa_ui_load_data_load_pro.pro)

## CL_UI_LOAD_DATA

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

    NAME:
      cl_ui_load_data

    PURPOSE:
      This routine builds a load data panel of widgets for the Cluster mission and
      handles the widget events produces.

    HISTORY:
    $LastChangedBy: jimm $
    $LastChangedDate: 2014-02-11 10:54:32 -0800 (Tue, 11 Feb 2014) $
    $LastChangedRevision: 14326 $

(See projects/cluster/spedas_plugin/cl_ui_load_data.pro)

## CL_UI_LOAD_DATA_LOAD_PRO

[Previous Routine] [List of Routines]

    NAME:
      cl_ui_load_data_load_pro

    PURPOSE:
      This routine provides an example for loading data into the GUI from the load
      data panel. The purpose of this routine is to provide a wrapper around the
      actual load data procedure (which is mission specific). This routine handles
      all the 'administrative' work of validating times, checking if data exists,
      and adding the data to the GUI's loadedData object. The loadedData object
      loads and tracks all data that is available to the GUI.

     INPUT:
      loadStruc - this structure contains all the mission specific information that
                  is required by the procedure that loads the data.
                  For purposes of demonstration, this rouine uses the following
                  parameters:
                  probe - ['1','2','3','4']
                  instrument - character string (or array) containing the name of
                               the instrument such as 'fgm', 'epd', 'mrma', 'mrmi,
                               or 'state'
                  time range - an array of 2 character strings containing the
                               start and stop times of the data to be loaded.
                               ['2007-03-23/00:00:00', '2007-03-24/00:00:00']
      loadedData - the loaded data object contains information on all variables
                   currently loaded in the gui. This object is used by many other
                   panels to display the variables that are available to the GUI.
                   Whenever new data is imported to the GUI this object must be
                   updated.
      statusBar - the status bar object used to display textual information
                  for the user and is located at the bottom of the load windows.
                  This object can be used to inform the user of successful
                  executions, warnings, and/or errors.
      historyWin - the history window object displays all messages generated
                   during this session.
      parent_widget_id - the widget ID of the parent. This ID is needed for
                         appropriate layering and modality of popups

      KEYWORDS (OPTIONAL):
      replay - set this flag to replay previous dproc operations
      overwrite - this flag allows the replay of user overwrites

    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/tags/spedas_1_00/spedas/gui/api_examples/load_data_tab/cl_ui_load_data_load_pro.pro $

(See projects/cluster/spedas_plugin/cl_ui_load_data_load_pro.pro)