Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

external/spdfcdas/

spdfcdawebchooser.pro


This program provides a GUI for choosing datasets from CDAWeb.

Author information

Author

B. Harris

Copyright

Copyright (c) 2010-2013 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

nwin
twinscolorbar
spdfSelectDataview, tlb, dvList, dvIndex

Selects a dataview.

spdfDataviewSelected, event

Responds to a "dataview selected" event.

result = spdfGetDatasetDescription(descriptions, id)

Finds the specified dataset description within the given array of descriptions.

spdfDatasetTreeEvent, event

Responds to a dataset tree event.

spdfViewNotes, event

Responds to a request to view a dataset's notes.

spdfCloseInventory, event

Responds to an inventory window close event.

spdfViewInventory, event

Responds to a request to view a dataset's inventory.

spdfDefaultTime, event

Responds to a request to set a default time value.

spdfIgnoreSelected, event

Responds to an event by doing nothing (ignoring it).

result = spdfSaveDataButton(event)

Responds to a "save data" button event.

spdfFindDatasets, event

Responds 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.

spdfGetCdawebDataCmd, state, timeInterval, datasetId, varNames

Creates IDL statements to read the specified data into an IDL environment.

result = spdfCdfEpoch2Julday(epoch)
spdfGetCdawebDataExec, state, timeInterval, datasetId, varNames

Executes the the operation to retrieve the specified data into this IDL environment.

spdfGetCdawebData, event

Responds to an event requesting the retrieval of the data specified by the users previous selections.

spdfGetCdawebDataIdl, event

Responds to an event requesting the IDL code to retrieve the data specified by the users previous selections.

spdfReadLocalData, event

Responds to an event requesting that data be read from a local file.

spdfGetCdawebPlot, event

Responds to an event requesting the CDAWlib's plot of the retrieved data specified by the users previous selections.

spdfCreateCdawebListing, event

Responds to an event requesting the CDAWlib's listing of the retrieved data specified by the users previous selections.

spdfExit, event

Responds to an event that initiates a termination of this program.

spdfAbout, event

Display information about this software.

result = spdfGetDataviews(cdas)

Gets all dataview descriptions.

spdfCdawebChooser [, endpoint=string] [, GROUP_LEADER=int]

Provides a GUI for choosing and retrieving data from CDAWeb.

Routine details

top source nwin

nwin

top source twinscolorbar

twinscolorbar

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 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 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 spdfCdfEpoch2Julday

result = spdfCdfEpoch2Julday(epoch)

Parameters

epoch

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] [, GROUP_LEADER=int]

Provides a GUI for choosing and retrieving data from CDAWeb.

Keywords

endpoint in optional type=string default=http://cdaweb.gsfc.nasa.gov/WS/cdasr/1

URL of CDAS web service.

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: Thu Mar 13 16:35:32 2014
Lines: 771