![[attach.png]](../../../idldoc-resources/attach.png)
spedas/gui/panels/
spd_ui_spdfcdawebchooser.pro
NAME: spd_ui_spdfcdawebchooser PURPOSE: This procedure opens a GUI that can download CDF files from CDAWEB. CATEGORY: Widgets CALLING SEQUENCE: spd_ui_spdfcdawebchooser INPUTS: OPTIONAL INPUTS: KEYWORD PARAMETERS: GROUP_LEADER: This is the id of the calling widget, required to show as a modal window. HISTORYWIN: The history window of SPEDAS. Required for the calendar widget. STATUSBAR: The main bar of the main window of SPEDAS. Required for the calendar widget. OUTPUTS: This function returns a CDF file. Also, it stores the values into variable spd_spdfdata. If there is no data read, it shows a message to the user. EXAMPLE: spd_ui_spdfcdawebchooser, historyWin=info.historyWin, statusBar=info.statusBar, GROUP_LEADER = info.master NOTES:; This window was adapted from the file spdfCdawebChooser.pro of spdfcdas http://cdaweb.gsfc.nasa.gov/WebServices MODIFICATION HISTORY: $LastChangedBy: pcruce $ $LastChangedDate: 2014-07-30 18:17:41 -0700 (Wed, 30 Jul 2014) $ $LastChangedRevision: 15630 $ $URL: svn+ssh://thmsvn@ambrosia.ssl.berkeley.edu/repos/spdsoft/trunk/spedas/gui/panels/spd_ui_spdfcdawebchooser.pro $
Routines
Routines from spd_ui_spdfcdawebchooser.pro
result = spd_string_replacen(inString, findString, replaceString)Find and replace for strings.
fix_spedas_depend_time, cdffileDeletes DEPEND_TIME attributes for SPEDAS and ARTEMIS CDF files.
result = spd_tranform_time_to_spdf(time)Gives a time string in the format used by spdf.
spd_spdfExit, eventResponds to an event that initiates a termination of this program.
spd_spdfSelectDataview, tlb, dvList, dvIndexSelects a dataview.
spd_spdfGetCdawebDataExec, event, state, timeInterval, datasetId, varNamesExecutes the the operation to retrieve the specified data into this IDL environment.
result = spd_spdfGetDatasetSelection(datasetTree, selectedDatasetId, selectedVarNames)Gets the dataset and variable selection values.
result = spd_spdfIsValidDate(value)Determines if the given string is a valid date/time value.
result = spd_spdfGetSpecifiedTime(startTimeWidget, stopTimeWidget)Gets the specified time interval.
spd_spdfGetCdawebData, eventResponds to an event requesting the retrieval of the data specified by the users previous selections.
result = spd_spdfGetDataviews(cdas)Gets all dataview descriptions.
spd_GetCdawebDataRun, eventResponds to an event requesting the retrieval of the data specified by the users previous selections.
spd_ui_spdfcdawebchooser_event, eventResponds to an event
spd_spdf_savecdfdir, eventspd_ui_spdfcdawebchooser, historyWin=int, GROUP_LEADER=int, timeRangeObj=obj, callSequence=callSequenceProvides a GUI for choosing and retrieving data from CDAWeb.
Routine details
top source spd_string_replacen
result = spd_string_replacen(inString, findString, replaceString)
Find and replace for strings.
Return value
new string inString where findString is replaced by replaceString.
Parameters
- inString in type=string
input string.
- findString in type=string
find string. It can be a regular expression.
- replaceString in type=string
replace string.
top source fix_spedas_depend_time
fix_spedas_depend_time, cdffile
Deletes DEPEND_TIME attributes for SPEDAS and ARTEMIS CDF files. The problem is that CDA web creates CDF files with twice as many time points but the EPOCH time points are correct. So we delete the DEPEND_TIME which points to Unix times and then cdf2tplot will use EPOCH times. This problem exists only for spedas and artemis.
Parameters
- cdffile in type=string
CDF filename (full path)
top source spd_tranform_time_to_spdf
result = spd_tranform_time_to_spdf(time)
Gives a time string in the format used by spdf.
Return value
new string time in the SPDF format 2007/03/23 00:00:00.
Parameters
- time in type=string
time in the SPEDAS format 2007-03-23/00:00:00.
top source spd_spdfExit
spd_spdfExit, event
Responds to an event that initiates a termination of this program.
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spd_spdfSelectDataview
spd_spdfSelectDataview, tlb, dvList, dvIndex
Selects a dataview.
Parameters
- tlb in type=int
widget id of top level base.
- dvList in type=int
widget id of dataview list widget.
- dvIndex in type=int
index of dataview to select
top source spd_spdfGetCdawebDataExec
spd_spdfGetCdawebDataExec, event, state, timeInterval, datasetId, varNames
Executes the the operation to retrieve the specified data into this IDL environment.
Parameters
- event
- state in type=struct
widget program's state.
- timeInterval in type=SpdfTimeInterval
time range of data to get.
- datasetId in type=string
dataset identifier.
- varNames in type=strarr
names of variables containing the desired data.
top source spd_spdfGetDatasetSelection
result = spd_spdfGetDatasetSelection(datasetTree, selectedDatasetId, selectedVarNames)
Gets the dataset and variable selection values.
Return value
1 if a valid selections was made. 0 if the selection was invalid.
Parameters
- datasetTree in type=int
id of dataset tree widget.
- selectedDatasetId out type=string
id of selected dataset.
- selectedVarNames out type=strarr
names of selected variables.
top source spd_spdfIsValidDate
result = spd_spdfIsValidDate(value)
Determines if the given string is a valid date/time value.
Return value
true if the given string is a valid date/time value. Otherwise false.
Parameters
- value in type=string
value to be tested.
top source spd_spdfGetSpecifiedTime
result = spd_spdfGetSpecifiedTime(startTimeWidget, stopTimeWidget)
Gets the specified time interval.
Return value
specifed time interval or null object reference if an invalid value was specified.
Parameters
- startTimeWidget in type=int
id of start time widget.
- stopTimeWidget in type=int
id of stop time widget.
top source spd_spdfGetCdawebData
spd_spdfGetCdawebData, event
Responds to an event requesting the retrieval of the data specified by the users previous selections.
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spd_spdfGetDataviewsprivate
result = spd_spdfGetDataviews(cdas)
Gets all dataview descriptions.
Return value
objarr containing SpdfDataviewDescription objects for all cdaweb dataviews.
Parameters
- cdas in required type=SpdfCdas
the Coordinated Data Analysis System.
top source spd_GetCdawebDataRun
spd_GetCdawebDataRun, event
Responds to an event requesting the retrieval of the data specified by the users previous selections.
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spd_ui_spdfcdawebchooser_event
spd_ui_spdfcdawebchooser_event, event
Responds to an event
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spd_ui_spdfcdawebchooser
spd_ui_spdfcdawebchooser, historyWin=int, GROUP_LEADER=int, timeRangeObj=obj, callSequence=callSequence
Provides a GUI for choosing and retrieving data from CDAWeb.
Keywords
- historyWin in type=int
The widget ID of history of the main window
- GROUP_LEADER in type=int
The widget ID of the group leader for this window. If no value is provided, the resulting window will not belong to a group and will be non-blocking.
- timeRangeObj in type=obj
Object reference for the GUI time range. (Allows webChooser to maintain time range state when panel is opened and closed)
- callSequence
File attributes
| Modification date: | Tue Oct 21 13:53:40 2014 |
| Lines: | 520 |