![[attach.png]](idldoc-resources/attach.png)
./
spdfcdawebchooser.pro
This program provides a GUI for choosing datasets from CDAWeb.
Author information
- Author
B. Harris
- Copyright
Copyright (c) 2010-2023 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.
Routines
Routines from spdfcdawebchooser.pro
nwintvimagetwinscolorbarresult = IDLFFDICOMEXISLICENSED()spdfSelectDataview, tlb, dvList, dvIndexSelects a dataview.
spdfDataviewSelected, eventResponds to a "dataview selected" event.
result = spdfGetDatasetDescription(descriptions, id)Finds the specified dataset description within the given array of descriptions.
spdfDatasetTreeEvent, eventResponds to a dataset tree event.
spdfViewNotes, eventResponds to a request to view a dataset's notes.
spdfViewDoi, eventResponds to a request to view a dataset's DOI/SPASE description.
spdfShowAsOnlineHelp, urlDisplays the given URL using the IDL ONLINE_HELP procedure.
spdfCloseInventory, eventResponds to an inventory window close event.
spdfViewInventory, eventResponds to a request to view a dataset's inventory.
spdfDefaultTime, eventResponds to a request to set a default time value.
spdfIgnoreSelected, eventResponds to an event by doing nothing (ignoring it).
result = spdfSaveDataButton(event)Responds to a "save data" button event.
spdfFindDatasets, eventResponds to an event that initiates a search for datasets that satisfies the users previous selections.
result = spdfIsValidDate(value)Determines if the given string is a valid date/time value.
result = spdfGetDatasetSelection(datasetTree, selectedDatasetId, selectedVarNames)Gets the dataset and variable selection values.
result = spdfGetSpecifiedTime(startTimeWidget, stopTimeWidget)Gets the specified time interval.
spdfBinHelp, eventResponds to a request to view the binning help.
spdfSpikeRemovalHelp, eventResponds to a request to view the spike removal help.
result = spdfBinDataButton(event)Responds to a "bin data" button event.
result = spdfBinMissingValues(event)Responds to a "bin missing values" button event.
spdfSpikeRemovalSelected, eventResponds to a "spike removal selected" event.
result = spdfBinOverrideDefaultBinning(event)Responds to a "bin override default binning" button event.
result = spdfGetBinData(state)Gets the BinData value from the associated widgets.
spdfCloseBinWindow, eventResponds to a close bin data window event.
spdfBinDataWindow, eventResponds to a request to set data binning parameters.
spdfGetCdawebDataCmd, state, timeInterval, datasetId, varNamesCreates IDL statements to read the specified data into an IDL environment.
result = spdfCdfEpoch2Julday(epoch)spdfGetCdawebDataExec, state, timeInterval, datasetId, varNamesExecutes the the operation to retrieve the specified data into this IDL environment.
spdfGetCdawebData, eventResponds to an event requesting the retrieval of the data specified by the users previous selections.
spdfGetCdawebDataIdl, eventResponds to an event requesting the IDL code to retrieve the data specified by the users previous selections.
spdfReadLocalData, eventResponds to an event requesting that data be read from a local file.
spdfGetCdawebPlot, eventResponds to an event requesting the CDAWlib's plot of the retrieved data specified by the users previous selections.
spdfCreateCdawebListing, eventResponds to an event requesting the CDAWlib's listing of the retrieved data specified by the users previous selections.
spdfExit, eventResponds to an event that initiates a termination of this program.
spdfAbout, eventDisplay information about this software.
result = spdfGetDataviews(cdas)Gets all dataview descriptions.
spdfCdawebChooser [, endpoint=string] [, sslVerifyPeer=int] [, GROUP_LEADER=int]Provides a GUI for choosing and retrieving data from CDAWeb.
Routine details
top source spdfSelectDataview
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 spdfDataviewSelected
spdfDataviewSelected, event
Responds to a "dataview selected" event.
Parameters
- event in type=widget event
widget_list event.
top source spdfGetDatasetDescriptionprivate
result = spdfGetDatasetDescription(descriptions, id)
Finds the specified dataset description within the given array of descriptions.
Return value
Dataset description from descriptions with the specified id or a NULL object reference if the description was not found.
Parameters
- descriptions in type=SpdfDatasetDescription
Array of descriptions to search (for example, state.datasets).
- id in type=string
Dataset identifier.
top source spdfDatasetTreeEvent
spdfDatasetTreeEvent, event
Responds to a dataset tree event.
Parameters
- event in type=widget event
event triggering the execution of this procedure
top source spdfViewNotes
spdfViewNotes, event
Responds to a request to view a dataset's notes.
Parameters
- event in type=widget event
event triggering the execution of this procedure
top source spdfViewDoi
spdfViewDoi, event
Responds to a request to view a dataset's DOI/SPASE description.
Parameters
- event in type=widget event
event triggering the execution of this procedure
top source spdfShowAsOnlineHelp
spdfShowAsOnlineHelp, url
Displays the given URL using the IDL ONLINE_HELP procedure. Refer to the ONLINE_HELP documentation for the types of files that are supported.
Parameters
- url in type=string
URL of file to download and display with ONLINE_HELP. This url may contain an HTML fragment identifier.
top source spdfCloseInventory
spdfCloseInventory, event
Responds to an inventory window close event.
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spdfViewInventory
spdfViewInventory, event
Responds to a request to view a dataset's inventory.
Parameters
- event in type=widget event
event triggering the execution of this procedure
top source spdfDefaultTime
spdfDefaultTime, event
Responds to a request to set a default time value.
Parameters
- event in type=widget event
event triggering the execution of this procedure
top source spdfIgnoreSelected
spdfIgnoreSelected, event
Responds to an event by doing nothing (ignoring it).
Parameters
- event in type=widget event
event triggering the execution of this procedure.
top source spdfSaveDataButton
result = spdfSaveDataButton(event)
Responds to a "save data" button event.
Return value
0
Parameters
- event in type=widget event
event triggering the execution of this function.
top source spdfFindDatasets
spdfFindDatasets, event
Responds to an event that initiates a search for datasets that satisfies the users previous selections.
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spdfIsValidDate
result = 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 spdfGetDatasetSelection
result = 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 spdfGetSpecifiedTime
result = 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 spdfBinHelp
spdfBinHelp, event
Responds to a request to view the binning help.
Parameters
- event in type=widget event
event triggering the execution of this procedure
top source spdfSpikeRemovalHelp
spdfSpikeRemovalHelp, event
Responds to a request to view the spike removal help.
Parameters
- event in type=widget event
event triggering the execution of this procedure
top source spdfBinDataButton
result = spdfBinDataButton(event)
Responds to a "bin data" button event. The current selection value is saved in state.
Return value
0
Parameters
- event in type=widget event
event triggering the execution of this function.
top source spdfBinMissingValues
result = spdfBinMissingValues(event)
Responds to a "bin missing values" button event. The current selection value is saved in state.
Return value
0
Parameters
- event in type=widget event
event triggering the execution of this function.
top source spdfSpikeRemovalSelected
spdfSpikeRemovalSelected, event
Responds to a "spike removal selected" event. The current selection value is saved in state.
Parameters
- event in type=widget event
widget_list event.
top source spdfBinOverrideDefaultBinning
result = spdfBinOverrideDefaultBinning(event)
Responds to a "bin override default binning" button event. The current selection value is saved in state.
Return value
0
Parameters
- event in type=widget event
event triggering the execution of this function.
top source spdfGetBinData
result = spdfGetBinData(state)
Gets the BinData value from the associated widgets.
Return value
the current BinData value or a null object if binning is not currently selected. If the interval values is invalid an error dialog is displayed and a null object is returned.
Parameters
- state in type=struct
widget program's state.
top source spdfCloseBinWindow
spdfCloseBinWindow, event
Responds to a close bin data window event.
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spdfBinDataWindow
spdfBinDataWindow, event
Responds to a request to set data binning parameters.
Parameters
- event in type=widget event
event triggering the execution of this procedure
top source spdfGetCdawebDataCmd
spdfGetCdawebDataCmd, state, timeInterval, datasetId, varNames
Creates IDL statements to read the specified data into an IDL environment.
Parameters
- state in type=struct
widget program's state.
- timeInterval in type=SpdfTimeInterval
time range of data to get. If this is not a valid object reference, then the generated IDL statement contains the variable names t_init and t_final instead of actual time values.
- datasetId in type=string
dataset identifier.
- varNames in type=strarr
names of variables containing the desired data.
top source spdfGetCdawebDataExec
spdfGetCdawebDataExec, state, timeInterval, datasetId, varNames
Executes the the operation to retrieve the specified data into this IDL environment.
Parameters
- 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 spdfGetCdawebData
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 spdfGetCdawebDataIdl
spdfGetCdawebDataIdl, event
Responds to an event requesting the IDL code to retrieve the data specified by the users previous selections.
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spdfReadLocalData
spdfReadLocalData, event
Responds to an event requesting that data be read from a local file.
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spdfGetCdawebPlot
spdfGetCdawebPlot, event
Responds to an event requesting the CDAWlib's plot of the retrieved data specified by the users previous selections.
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spdfCreateCdawebListing
spdfCreateCdawebListing, event
Responds to an event requesting the CDAWlib's listing of the retrieved data specified by the users previous selections.
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spdfExit
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 spdfAbout
spdfAbout, event
Display information about this software.
Parameters
- event in type=widget_button
event triggering the execution of this procedure.
top source spdfGetDataviewsprivate
result = 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 spdfCdawebChooser
spdfCdawebChooser [, endpoint=string] [, sslVerifyPeer=int] [, GROUP_LEADER=int]
Provides a GUI for choosing and retrieving data from CDAWeb. If access to the Internet is through an HTTP proxy, the caller should ensure that the HTTP_PROXY environment is correctly set before this procedure is called. The HTTP_PROXY value should be of the form http://username:password@hostname:port/.
Keywords
- endpoint in optional type=string default=SpdfCdas->getDefaultEndpoint()
URL of CDAS web service.
- sslVerifyPeer in optional type=int default=spdfGetDefaultSslVerify()
Specifies whether the authenticity of the peer's SSL certificate should be verified. When 0, the connection succeeds regardless of what the peer SSL certificate contains.
- GROUP_LEADER in optional 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.
File attributes
| Modification date: | Mon May 20 05:39:06 2024 |
| Lines: | 1,020 |
CDAS Feedback.