Complete CDAS R1.8.6 Web Services API

Generated by IDLdoc

Index

.     A     B     C     D     E     F     G     H     I     K     L     M     N     O     P     Q     R     S     T     U     V     W     X    

.

./ directory

A

additionalMetadata field in class SpdfDatasetDescription

links to additional metadata for this dataset.

additionalMetadata parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

(type=objarr of SpdfAdditionalMetadata} links to additional metadata.

AUTHENTICATION field in class SpdfHttpProxy
authentication keyword in routine SpdfHttpProxy::init in file spdfhttpproxy__define.pro

Type of authentication used when connecting to a proxy server.

authentication property in class SpdfHttpProxy
authenticator keyword in routine SpdfCdas::getObservatoryGroups in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getInstrumentTypes in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getInventory in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getExampleTimeInterval in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getVariables in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getVariableNames in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getCdfData in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getTextData in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getGraphData in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::getData in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::makeGetRequest in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::makePostRequest in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

authenticator keyword in routine SpdfCdas::handleHttpError in file spdfcdas__define.pro

authenticator that is used when a dataview requiring authentication is specified.

B

basicFormat keyword in routine SpdfTimeInterval::getIso8601FromJulDay in file spdftimeinterval__define.pro

Indicates whether the "basic" (minimal field separators) ISO 8601 format is to be returned.

basicFormat keyword in routine SpdfTimeInterval::getIso8601Start in file spdftimeinterval__define.pro

Indicates whether the "basic" (minimal field separators) ISO 8601 format is to be returned.

basicFormat keyword in routine SpdfTimeInterval::getIso8601Stop in file spdftimeinterval__define.pro

Indicates whether the "basic" (minimal field separators) ISO 8601 format is to be returned.

basicIso8601Format field in class SpdfTimeInterval

constant format string for a "basic" (minimal field separators) ISO 8601 value.

binData keyword in routine SpdfCdas::getCdfData in file spdfcdas__define.pro

data binning parameters to apply to the result file.

binData keyword in routine SpdfCdas::getTextData in file spdfcdas__define.pro

data binning parameters to apply to the result file.

binData keyword in routine SpdfCdas::getGraphData in file spdfcdas__define.pro

data binning parameters to apply to the result file.

binData keyword in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

data binning parameters to apply to the result file.

binData keyword in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

data binning parameters to apply to the result file.

binData field in class SpdfCdfRequest

data binning parameters.

binData keyword in routine SpdfCdfRequest::init in file spdfcdfrequest__define.pro

data binning parameters to apply to result file.

binData property in class SpdfCdfRequest
binData field in class SpdfGraphRequest

data binning parameters.

binData keyword in routine SpdfGraphRequest::init in file spdfgraphrequest__define.pro

data binning parameters to apply to result file.

binData property in class SpdfGraphRequest
binData field in class SpdfTextRequest

data binning parameters.

binData keyword in routine SpdfTextRequest::init in file spdftextrequest__define.pro

data binning parameters to apply to result file.

binData property in class SpdfTextRequest
binInterpolateMissingValues keyword in routine SpdfGetData in file spdfgetdata.pro

flag indicating whether to interpolate missing values.

binInterval keyword in routine SpdfGetData in file spdfgetdata.pro

binning interval (seconds).

binOverrideDefaultBinning keyword in routine SpdfGetData in file spdfgetdata.pro

flag indicating whether to override the default selection of variables to bin.

binSigmaMultiplier keyword in routine SpdfGetData in file spdfgetdata.pro

standard deviation multiplier used for rejecting data.

buffer keyword in routine SpdfFileDescription::getFile in file spdffiledescription__define.pro

if this keyword is set, the return value is a buffer and the FILENAME keyword is ignored.

C

callback_data keyword in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

this keyword value contains data that is passed to the caller when a callback is made.

callback_data keyword in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

this keyword value contains data that is passed to the caller when a callback is made.

callback_data keyword in routine SpdfCdas::download in file spdfcdas__define.pro

this keyword value contains data that is passed to the caller when a callback is made.

callback_data keyword in routine SpdfFileDescription::getFile in file spdffiledescription__define.pro

this keyword value contains data that is passed to the caller when a callback is made.

callback_data keyword in routine SpdfGetData in file spdfgetdata.pro

this keyword value contains data that is passed to the caller when a callback is made.

callback_function keyword in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

this keyword value is the name of the IDL function that is to be called during this retrieval operation.

callback_function keyword in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

this keyword value is the name of the IDL function that is to be called during this retrieval operation.

callback_function keyword in routine SpdfCdas::download in file spdfcdas__define.pro

this keyword value is the name of the IDL function that is to be called during this retrieval operation.

callback_function keyword in routine SpdfFileDescription::getFile in file spdffiledescription__define.pro

this keyword value is the name of the IDL function that is to be called during this retrieval operation.

callback_function keyword in routine SpdfGetData in file spdfgetdata.pro

this keyword value is the name of the IDL function that is to be called during this retrieval operation.

callbackData parameter in routine SpdfGetDataCallback in file spdfgetdata.pro

cdas parameter in routine spdfGetDataviews in file spdfcdawebchooser.pro

the Coordinated Data Analysis System.

cdawebFormat field in class SpdfTimeInterval

constant format string for a "cdaweb" time format.

cdfFormat keyword in routine SpdfCdas::getCdfData in file spdfcdas__define.pro

CDF format of returned data.

cdfFormat field in class SpdfCdfRequest

indicates the desired format of the CDF file.

cdfFormat keyword in routine SpdfCdfRequest::init in file spdfcdfrequest__define.pro

format of CDF file.

cdfFormat property in class SpdfCdfRequest
cdfVersion keyword in routine SpdfCdas::getCdfData in file spdfcdas__define.pro

is the CDF file version that any created CDF files should be (2 or 3).

cdfVersion field in class SpdfCdfRequest

indicates the desired version of the CDF file.

cdfVersion keyword in routine SpdfCdfRequest::init in file spdfcdfrequest__define.pro

version of CDF file.

cdfVersion property in class SpdfCdfRequest
children field in class SpdfVariableDescription

names of child variables.

children keyword in routine SpdfVariableDescription::init in file spdfvariabledescription__define.pro

names of child variables

children property in class SpdfVariableDescription
compression keyword in routine SpdfCdas::getTextData in file spdfcdas__define.pro

the type of compression to use on the result file.

compression field in class SpdfTextRequest

compression options of result.

compression keyword in routine SpdfTextRequest::init in file spdftextrequest__define.pro

compression algorithms to apply to result file.

compression property in class SpdfTextRequest
credentialsCache field in class SpdfAuthenticator

cache of authentication credentials.

currentVersionUrl field in class SpdfCdas

URL to the file identifying the most up to date version of this class.

D

dataRequest parameter in routine SpdfCdas::getData in file spdfcdas__define.pro

specifies the data to get.

dataRequestEntity field in class SpdfCdasDataRequest

data-requent entity.

dataRequestEntity parameter in routine SpdfCdasDataRequest::init in file spdfcdasdatarequest__define.pro

a data request.

dataset parameter in routine SpdfCdas::getInventory in file spdfcdas__define.pro

identifies the dataset.

dataset parameter in routine SpdfCdas::getExampleTimeInterval in file spdfcdas__define.pro

identifies the dataset.

dataset parameter in routine SpdfCdas::getVariables in file spdfcdas__define.pro

identifies the dataset.

dataset parameter in routine SpdfCdas::getVariableNames in file spdfcdas__define.pro

identifies the dataset.

dataset parameter in routine SpdfCdas::getCdfData in file spdfcdas__define.pro

identifies the dataset from which data is being requested.

dataset parameter in routine SpdfCdas::getTextData in file spdfcdas__define.pro

identifies the dataset from which data is being requested.

dataset parameter in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

identifies the dataset from which data is being requested.

dataset parameter in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

identifies the dataset from which data is being requested.

dataset parameter in routine SpdfGetData in file spdfgetdata.pro

name of dataset to get data from.

dataset field in class SpdfThumbnailDescription

dataset identifier.

dataset parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

datasetId parameter in routine spdfGetCdawebDataCmd in file spdfcdawebchooser.pro

dataset identifier.

datasetId parameter in routine spdfGetCdawebDataExec in file spdfcdawebchooser.pro

dataset identifier.

datasetId field in class SpdfDatasetRequest

dataset identifier.

datasetId parameter in routine SpdfDatasetRequest::init in file spdfdatasetrequest__define.pro

dataset identifier.

datasetLinks field in class SpdfDatasetDescription

links to information about this dataset.

datasetLinks parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

links to information about this dataset.

datasetRequest field in class SpdfCdfRequest

identifies the dataset for this request.

datasetRequest parameter in routine SpdfCdfRequest::init in file spdfcdfrequest__define.pro

specifies the dataset information.

datasetRequest field in class SpdfTextRequest

dataset specification.

datasetRequest parameter in routine SpdfTextRequest::init in file spdftextrequest__define.pro

specifies the dataset information.

datasetRequests parameter in routine SpdfCdas::getGraphData in file spdfcdas__define.pro

identifies the datasets and variables from which data is being requested.

datasetRequests field in class SpdfGraphRequest

identifies the datasets for this request.

datasetRequests parameter in routine SpdfGraphRequest::init in file spdfgraphrequest__define.pro

specifies the dataset information.

datasetTree parameter in routine spdfGetDatasetSelection in file spdfcdawebchooser.pro

id of dataset tree widget.

dataview parameter in routine SpdfAuthenticator::getCredentials in file spdfauthenticator__define.pro

name of dataview requiring authentication to access.

dataview parameter in routine SpdfAuthenticator::getCachedCredentials in file spdfauthenticator__define.pro

name of dataview requiring authentication to access.

dataview parameter in routine SpdfAuthenticator::cacheCredentials in file spdfauthenticator__define.pro

name of dataview requiring authentication to access.

dataview parameter in routine SpdfAuthenticator::addToCachedCredentials in file spdfauthenticator__define.pro

name of dataview requiring authentication to access.

dataview keyword in routine SpdfCdas::getObservatoryGroups in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getInstrumentTypes in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getInventory in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getExampleTimeInterval in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getVariables in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getVariableNames in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getCdfData in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getTextData in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getGraphData in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

name of dataview to access.

dataview keyword in routine SpdfCdas::getData in file spdfcdas__define.pro

name of dataview to access.

dataview parameter in routine SpdfCdas::makeGetRequest in file spdfcdas__define.pro

name of dataview to access.

dataview parameter in routine SpdfCdas::makePostRequest in file spdfcdas__define.pro

name of dataview to access.

dataview parameter in routine SpdfCdas::handleHttpError in file spdfcdas__define.pro

name of dataview to access.

dataview parameter in routine SpdfCdawebChooserAuthenticator::getCredentials in file spdfcdawebchooserauthenticator__define.pro

name of dataview requiring authentication to access.

dataview keyword in routine SpdfGetData in file spdfgetdata.pro

name of dataview containing the dataset.

dataviewCache field in class SpdfAuthenticator

cache of dataview names.

dateTimeElement parameter in routine SpdfCdas::getJulDate in file spdfcdas__define.pro

list whose first child is to be converted into a julday

defaultDataview field in class SpdfCdas

CDAS dataview to access when the dataview is not specified.

defaultDataview keyword in routine SpdfCdas::init in file spdfcdas__define.pro

default CDAS dataview value to use in subsequent calls when no value is specified.

defaultDataview property in class SpdfCdas
descriptions parameter in routine spdfGetDatasetDescription in file spdfcdawebchooser.pro

Array of descriptions to search (for example, state.datasets).

doc parameter in routine SpdfBinData::createDomElement in file spdfbindata__define.pro

document in which to create the BinData element.

doc parameter in routine SpdfCdas::getDataResult in file spdfcdas__define.pro

cdas:DataResult XML document.

doc parameter in routine SpdfCdas::getFileDescriptions in file spdfcdas__define.pro

cdas:DataResult XML document.

doc parameter in routine SpdfCdasDataRequest::createDomElement in file spdfcdasdatarequest__define.pro

document in which to create the DataRequest element.

doc parameter in routine SpdfCdfRequest::createDomElement in file spdfcdfrequest__define.pro

document in which to create the CdfRequest element.

doc parameter in routine SpdfDatasetRequest::createDomElement in file spdfdatasetrequest__define.pro

document in which to create the DataRequest element.

doc parameter in routine SpdfGraphRequest::createDomElement in file spdfgraphrequest__define.pro

document in which to create the GraphRequest element.

doc parameter in routine SpdfTextRequest::createDomElement in file spdftextrequest__define.pro

document in which to create the TextRequest element.

doc parameter in routine SpdfTimeInterval::createDomElement in file spdftimeinterval__define.pro

document in which to create the TimeInterval element.

doi field in class SpdfDatasetDescription

digital object identifer (DOI) for dataset.

doi parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

digital object identifier.

domElement parameter in routine SpdfCdas::getNamedElementsFirstChildValue in file spdfcdas__define.pro

DOM element to search

domNode parameter in routine SpdfCdas::getTimeIntervalChild in file spdfcdas__define.pro

node from a cdas:DataResult XML document.

dvIndex parameter in routine spdfSelectDataview in file spdfcdawebchooser.pro

index of dataview to select

dvList parameter in routine spdfSelectDataview in file spdfcdawebchooser.pro

widget id of dataview list widget.

E

endpoint field in class SpdfCdas

URL of CDAS web service.

endpoint keyword in routine SpdfCdas::init in file spdfcdas__define.pro

URL of CDAS web service.

endpoint property in class SpdfCdas
endpoint keyword in routine SpdfCdasWsExample in file spdfcdaswsexample.pro

URL of CDAS web service.

endpoint keyword in routine spdfCdawebChooser in file spdfcdawebchooser.pro

URL of CDAS web service.

endpoint keyword in routine SpdfGetData in file spdfgetdata.pro

URL of CDAS web service.

endpointAddress field in class SpdfDataviewDescription

access URL.

endpointAddress parameter in routine SpdfDataviewDescription::init in file spdfdataviewdescription__define.pro

URL to access this dataview.

epoch parameter in routine spdfCdfEpoch2Julday in file spdfcdawebchooser.pro
errorReporter keyword in routine SpdfCdas::makeGetRequest in file spdfcdas__define.pro

name of IDL procedure to call if an HTTP error occurs.

errorReporter keyword in routine SpdfCdas::makePostRequest in file spdfcdas__define.pro

name of IDL procedure to call if an HTTP error occurs.

errorReporter keyword in routine SpdfCdas::handleHttpError in file spdfcdas__define.pro

name of IDL procedure to call if an HTTP error occurs.

errors field in class SpdfCdasDataResult

errors related to this result.

errors keyword in routine SpdfCdasDataResult::init in file spdfcdasdataresult__define.pro

errors related to this result.

errors property in class SpdfCdasDataResult
event parameter in routine spdfDataviewSelected in file spdfcdawebchooser.pro

widget_list event.

event parameter in routine spdfDatasetTreeEvent in file spdfcdawebchooser.pro

event triggering the execution of this procedure

event parameter in routine spdfViewNotes in file spdfcdawebchooser.pro

event triggering the execution of this procedure

event parameter in routine spdfViewDoi in file spdfcdawebchooser.pro

event triggering the execution of this procedure

event parameter in routine spdfCloseInventory in file spdfcdawebchooser.pro

event triggering the execution of this procedure.

event parameter in routine spdfViewInventory in file spdfcdawebchooser.pro

event triggering the execution of this procedure

event parameter in routine spdfDefaultTime in file spdfcdawebchooser.pro

event triggering the execution of this procedure

event parameter in routine spdfIgnoreSelected in file spdfcdawebchooser.pro

event triggering the execution of this procedure.

event parameter in routine spdfSaveDataButton in file spdfcdawebchooser.pro

event triggering the execution of this function.

event parameter in routine spdfFindDatasets in file spdfcdawebchooser.pro

event triggering the execution of this procedure.

event parameter in routine spdfBinHelp in file spdfcdawebchooser.pro

event triggering the execution of this procedure

event parameter in routine spdfSpikeRemovalHelp in file spdfcdawebchooser.pro

event triggering the execution of this procedure

event parameter in routine spdfBinDataButton in file spdfcdawebchooser.pro

event triggering the execution of this function.

event parameter in routine spdfBinMissingValues in file spdfcdawebchooser.pro

event triggering the execution of this function.

event parameter in routine spdfSpikeRemovalSelected in file spdfcdawebchooser.pro

widget_list event.

event parameter in routine spdfBinOverrideDefaultBinning in file spdfcdawebchooser.pro

event triggering the execution of this function.

event parameter in routine spdfCloseBinWindow in file spdfcdawebchooser.pro

event triggering the execution of this procedure.

event parameter in routine spdfBinDataWindow in file spdfcdawebchooser.pro

event triggering the execution of this procedure

event parameter in routine spdfGetCdawebData in file spdfcdawebchooser.pro

event triggering the execution of this procedure.

event parameter in routine spdfGetCdawebDataIdl in file spdfcdawebchooser.pro

event triggering the execution of this procedure.

event parameter in routine spdfReadLocalData in file spdfcdawebchooser.pro

event triggering the execution of this procedure.

event parameter in routine spdfGetCdawebPlot in file spdfcdawebchooser.pro

event triggering the execution of this procedure.

event parameter in routine spdfCreateCdawebListing in file spdfcdawebchooser.pro

event triggering the execution of this procedure.

event parameter in routine spdfExit in file spdfcdawebchooser.pro

event triggering the execution of this procedure.

event parameter in routine spdfAbout in file spdfcdawebchooser.pro

event triggering the execution of this procedure.

F

fileDescription parameter in routine getCdfFile in file spdfcdaswsexample.pro

description of a remote CDF file.

fileDescription parameter in routine getTextFile in file spdfcdaswsexample.pro

description of a remote CDF file.

fileDescription parameter in routine getFile in file spdfcdaswsexample.pro

description of a remote file

fileDescription parameter in routine getResultFile in file spdfcdaswsexample.pro

description of a remote file.

fileDescriptions parameter in routine SpdfCdas::download in file spdfcdas__define.pro

The remote files to download.

fileDescriptions field in class SpdfCdasDataResult

descriptions of the files comprising this result.

fileDescriptions parameter in routine SpdfCdasDataResult::init in file spdfcdasdataresult__define.pro

descriptions of the files comprising this result.

fileElement parameter in routine SpdfCdas::getThumbnailDescription in file spdfcdas__define.pro

cdas:FileDescription element from a cdas:DataResult XML document.

fileElement parameter in routine SpdfCdas::getThumbnailId in file spdfcdas__define.pro

cdas:FileDescription node.

filename keyword in routine SpdfFileDescription::getFile in file spdffiledescription__define.pro

set this keyword equal to a string that holds the file name and path where the retrieved file is locally stored.

format keyword in routine SpdfCdas::getTextData in file spdfcdas__define.pro

format of result file.

format field in class SpdfTextRequest

format of result.

format keyword in routine SpdfTextRequest::init in file spdftextrequest__define.pro

format of result file.

format property in class SpdfTextRequest

G

getCdfFile routine in spdfcdaswsexample.pro

This procedure demonstrates how to obtain a local copy of a remote CDF file and display some CDF information about the file's contents.

getDataResults routine in spdfcdaswsexample.pro

This procedure demonstrates how to examine the result of a data request.

getFile routine in spdfcdaswsexample.pro

This procedure demonstrates how to check the MIME-type of an SpdfFileDescription and, if it is of type "image/png", to get a local copy and display the image.

getResultFile routine in spdfcdaswsexample.pro

This procedure demonstrates how to examine an SpdfFileDescription and then display it based upon it MIME-type.

getTextFile routine in spdfcdaswsexample.pro

This procedure demonstrates how to obtain a local copy of a remote text file and display a portion of its contents.

graphOptions keyword in routine SpdfCdas::getGraphData in file spdfcdas__define.pro

graphing options.

graphOptions field in class SpdfGraphRequest

graph options for this request.

graphOptions keyword in routine SpdfGraphRequest::init in file spdfgraphrequest__define.pro

graph option bit-mask value.

graphOptions property in class SpdfGraphRequest
GROUP_LEADER keyword in routine spdfCdawebChooser in file spdfcdawebchooser.pro

The widget ID of the group leader for this window.

GROUPLEADER field in class SpdfCdawebChooserAuthenticator
groupLeader parameter in routine SpdfCdawebChooserAuthenticator::init in file spdfcdawebchooserauthenticator__define.pro

widget ID of "group leader" for this authentication widget.

H

header parameter in routine SpdfCdas::getResponseHeader in file spdfcdas__define.pro

name of response header to get.

HOSTNAME field in class SpdfHttpProxy
hostname keyword in routine SpdfHttpProxy::init in file spdfhttpproxy__define.pro

The proxy server name.

hostname property in class SpdfHttpProxy
httpErrorReporter keyword in routine SpdfCdas::getDataviews in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getObservatoryGroups in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getInstrumentTypes in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getInventory in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getExampleTimeInterval in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getVariables in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getVariableNames in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getCdfData in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getTextData in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getGraphData in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

used to report an HTTP error.

httpErrorReporter keyword in routine SpdfCdas::getData in file spdfcdas__define.pro

used to report an HTTP error.

I

id parameter in routine spdfGetDatasetDescription in file spdfcdawebchooser.pro

Dataset identifier.

id field in class SpdfDatasetDescription

dataset identifier.

id parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

dataset identifier.

id field in class SpdfDataviewDescription

identifier.

id parameter in routine SpdfDataviewDescription::init in file spdfdataviewdescription__define.pro

dataview identifier.

id field in class SpdfInventoryDescription

dataset identifier.

id parameter in routine SpdfInventoryDescription::init in file spdfinventorydescription__define.pro

dataset identifier.

identifier keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

a dataset identifier.

IDLFFDICOMEXISLICENSED routine in spdfcdawebchooser.pro
idPattern keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

a java.util.regex compatible regular expression that must match the dataset's identifier value.

imageFormat keyword in routine SpdfCdas::getGraphData in file spdfcdas__define.pro

Format options for graph.

imageFormats field in class SpdfGraphRequest

format options for this request.

imageFormats keyword in routine SpdfGraphRequest::init in file spdfgraphrequest__define.pro

format of graph file.

imageFormats property in class SpdfGraphRequest
instruments keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

names of instruments which restrict the returned datasets to only those supporting the specified instruments.

instruments field in class SpdfDatasetDescription

intruments that contributed data to this dataset.

instruments parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

intruments that contributed data to this dataset.

instrumentTypes keyword in routine SpdfCdas::getObservatoryGroups in file spdfcdas__define.pro

names of instrument-types which restrict the returned observatory groups to only those supporting the specified instrument-types.

instrumentTypes keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

names of instrument-types which restrict the returned datasets to only those supporting the specified instrument-types.

instrumentTypes field in class SpdfDatasetDescription

instrumentTypes that contributed data to this dataset.

instrumentTypes parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

instrumentTypes that contributed data to this dataset.

INTERPOLATEMISSINGVALUES field in class SpdfBinData
interpolateMissingValues parameter in routine SpdfBinData::init in file spdfbindata__define.pro

flag indicating whether to interpolate missing values.

INTERVAL field in class SpdfBinData
interval parameter in routine SpdfBinData::init in file spdfbindata__define.pro

binning interval (seconds).

iso8601Format field in class SpdfTimeInterval

constant format string for an ISO 8601 value.

K

keepfiles keyword in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

The KEEPFILES keyword causes downloaded data files to be retained.

keepfiles keyword in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

The KEEPFILES keyword causes downloaded data files to be retained.

keepfiles keyword in routine SpdfCdas::download in file spdfcdas__define.pro

The KEEPFILES keyword causes downloaded data files to be retained.

keepfiles keyword in routine SpdfGetData in file spdfgetdata.pro

The KEEPFILES keyword causes SpdfGetData to retain the downloaded data files.

L

label field in class SpdfDatasetDescription

dataset label.

label parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

dataset label.

labelPattern keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

a java.util.regex compatible regular expression that must match the dataset's label text.

lastModified field in class SpdfFileDescription

data of last modification (julday).

lastModified parameter in routine SpdfFileDescription::init in file spdffiledescription__define.pro

date file was last modified (julday value).

length field in class SpdfFileDescription

file's length (in bytes).

length parameter in routine SpdfFileDescription::init in file spdffiledescription__define.pro

length (in bytes) of file.

longDescription field in class SpdfVariableDescription

long description of variable.

longDescription parameter in routine SpdfVariableDescription::init in file spdfvariabledescription__define.pro

long description of varaible.

M

messages field in class SpdfCdasDataResult

messages related to this result.

messages keyword in routine SpdfCdasDataResult::init in file spdfcdasdataresult__define.pro

messages related to this result.

messages property in class SpdfCdasDataResult
mimeType field in class SpdfFileDescription

MIME-type of file.

mimeType parameter in routine SpdfFileDescription::init in file spdffiledescription__define.pro

(Multipurpose Internet Mail Extensions) MIME-type of file.

myScale field in class SpdfThumbnailDescription

myScale parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

N

name field in class SpdfFileDescription

name of file.

name parameter in routine SpdfFileDescription::init in file spdffiledescription__define.pro

name of file.

name field in class SpdfInstrumentTypeDescription

instrument-type name.

name parameter in routine SpdfInstrumentTypeDescription::init in file spdfinstrumenttypedescription__define.pro

instrument-type name.

name field in class SpdfObservatoryGroupDescription

name of group.

name parameter in routine SpdfObservatoryGroupDescription::init in file spdfobservatorygroupdescription__define.pro

name of observatory-group.

name field in class SpdfThumbnailDescription

name parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

name field in class SpdfVariableDescription

varable's name.

name parameter in routine SpdfVariableDescription::init in file spdfvariabledescription__define.pro

name of variable.

notes field in class SpdfDatasetDescription

notes about this dataset.

notes parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

notes about this dataset.

notesPattern keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

a java.util.regex compatible regular expression that must match the dataset's notes text.

noticeUrl field in class SpdfDataviewDescription

URL of notice.

noticeUrl parameter in routine SpdfDataviewDescription::init in file spdfdataviewdescription__define.pro

URL of notice concerning this dataview.

numCols field in class SpdfThumbnailDescription

number of columns of thumbnail images.

numCols parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

number of columns of thumbnail images.

numFrames field in class SpdfThumbnailDescription

number of thumbnail images.

numFrames parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

number of thumbnail images.

numRows field in class SpdfThumbnailDescription

number of rows of thumbnail images.

numRows parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

number of rows of thumbnail images.

nwin routine in spdfcdawebchooser.pro

O

observatories keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

names of observatories which restrict the returned datasets to only those supporting the specified observatories.

observatories field in class SpdfDatasetDescription

observatories that contributed data to this dataset.

observatories parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

observatories that contributed data to this dataset.

observatoryGroups keyword in routine SpdfCdas::getInstrumentTypes in file spdfcdas__define.pro

names of observatory-groups which restrict the returned instrument types to only those supporting the specified observatory-groups.

observatoryGroups keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

names of observatory-groups which restrict the returned datasets to only those supporting the specified observatory-groups.

observatoryGroups field in class SpdfDatasetDescription

observatoryGroups that contributed data to this dataset.

observatoryGroups parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

observatoryGroups that contributed data to this dataset.

observatoryIds field in class SpdfObservatoryGroupDescription

IDs of observatories belonging to this group.

observatoryIds parameter in routine SpdfObservatoryGroupDescription::init in file spdfobservatorygroupdescription__define.pro

identifiers of the observatories in this group.

options field in class SpdfThumbnailDescription

options parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

OVERRIDEDEFAULTBINNING field in class SpdfBinData
overrideDefaultBinning parameter in routine SpdfBinData::init in file spdfbindata__define.pro

flag indicating whether to override the default selection of variables to bin.

overview field in class SpdfDataviewDescription

overview description.

overview parameter in routine SpdfDataviewDescription::init in file spdfdataviewdescription__define.pro

overview description of this dataview.

P

parent field in class SpdfVariableDescription

name of parent variable.

parent keyword in routine SpdfVariableDescription::init in file spdfvariabledescription__define.pro

name of parent variable.

parent property in class SpdfVariableDescription
password parameter in routine SpdfAuthenticator::getCredentials in file spdfauthenticator__define.pro

user's password.

password parameter in routine SpdfAuthenticator::getCachedCredentials in file spdfauthenticator__define.pro

user's password.

password parameter in routine SpdfAuthenticator::cacheCredentials in file spdfauthenticator__define.pro

user's password.

password parameter in routine SpdfAuthenticator::addToCachedCredentials in file spdfauthenticator__define.pro

user's password.

password parameter in routine SpdfCdas::handleHttpError in file spdfcdas__define.pro

password value obtained by calling the given authenticator.

password parameter in routine SpdfCdas::getRequestUrl in file spdfcdas__define.pro

password.

password parameter in routine SpdfCdawebChooserAuthenticator::getCredentials in file spdfcdawebchooserauthenticator__define.pro

user's password.

PASSWORD field in class SpdfHttpProxy
password keyword in routine SpdfHttpProxy::init in file spdfhttpproxy__define.pro

Password for authenticating with the proxy server.

password property in class SpdfHttpProxy
piAffiliation field in class SpdfDatasetDescription

affiliation of PI.

piAffiliation parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

affiliation of PI.

piName field in class SpdfDatasetDescription

name of Principal Investigator.

piName parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

name of Principal Investigator.

PORT field in class SpdfHttpProxy
port keyword in routine SpdfHttpProxy::init in file spdfhttpproxy__define.pro

The proxy's TCP/IP port.

port property in class SpdfHttpProxy
progressInfo parameter in routine SpdfGetDataCallback in file spdfgetdata.pro

proxySettings field in class SpdfCdas

HTTP proxy settings to use.

proxySettings field in class SpdfFileDescription

HTTP proxy settings to use.

publicAccess field in class SpdfDataviewDescription

public-access flag.

publicAccess parameter in routine SpdfDataviewDescription::init in file spdfdataviewdescription__define.pro

indicates whether the dataview requires authentication to access.

Q

quiet keyword in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

Suppresses error messages.

quiet keyword in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

Suppresses error messages.

quiet keyword in routine SpdfCdas::download in file spdfcdas__define.pro

Suppresses error messages.

quiet keyword in routine SpdfGetData in file spdfgetdata.pro

SpdfGetData normally prints an error message if no data is found.

R

request parameter in routine SpdfCdas::getResponseHeader in file spdfcdas__define.pro

HTTP request.

request parameter in routine SpdfCdas::handleHttpError in file spdfcdas__define.pro

HTTP request that caused the error.

resourceId field in class SpdfDatasetDescription

SPASE ResourceID for dataset.

resourceId parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

SPASE ResourceID.

responseCode parameter in routine SpdfHttpErrorDialog::reportError in file spdfhttperrordialog__define.pro

the HTTP response code of the request causing the error.

responseCode parameter in routine SpdfHttpErrorReporter::reportError in file spdfhttperrorreporter__define.pro

the HTTP response code of the request causing the error.

responseFilename parameter in routine SpdfHttpErrorDialog::reportError in file spdfhttperrordialog__define.pro

the name of an error response file sent when the error occurred.

responseFilename parameter in routine SpdfHttpErrorReporter::reportError in file spdfhttperrorreporter__define.pro

the name of an error response file sent when the error occurred.

responseFilename parameter in routine SpdfHttpErrorReporter::printResponse in file spdfhttperrorreporter__define.pro

the name of an error response file sent when the error occurred.

responseHeader parameter in routine SpdfHttpErrorDialog::reportError in file spdfhttperrordialog__define.pro

the HTTP response header of the request causing the error.

responseHeader parameter in routine SpdfHttpErrorReporter::reportError in file spdfhttperrorreporter__define.pro

the HTTP response header of the request causing the error.

resultDoc parameter in routine SpdfCdas::getDataResultText in file spdfcdas__define.pro

cdas:DataResult XML document.

results parameter in routine getDataResults in file spdfcdaswsexample.pro

results of a data request.

retryAfterTime field in class SpdfHttpErrorReporter

number of seconds elapsed since 1970-01-01 when we can retry a request following an HTTP response with status 429/503 and an HTTP Retry-After header value.

retryLimit field in class SpdfCdas

retry limit for requests that fail with an http status of 429 or 503 with a Retry-After header.

S

selectedDatasetId parameter in routine spdfGetDatasetSelection in file spdfcdawebchooser.pro

id of selected dataset.

selectedVarNames parameter in routine spdfGetDatasetSelection in file spdfcdawebchooser.pro

names of selected variables.

shortDescription field in class SpdfVariableDescription

short description of variable.

shortDescription parameter in routine SpdfVariableDescription::init in file spdfvariabledescription__define.pro

short description of varaible.

shortIso8601Format field in class SpdfTimeInterval

short version of a constant format string for an ISO 8601 value.

SIGMAMULTIPLIER field in class SpdfBinData
sigmaMultiplier parameter in routine SpdfBinData::init in file spdfbindata__define.pro

standard deviation multiplier used for rejecting data.

spdfAbout routine in spdfcdawebchooser.pro

Display information about this software.

SpdfAdditionalMetadata class
SpdfAdditionalMetadata::cleanup routine in spdfadditionalmetadata__define.pro

Performs cleanup operations when this object is destroyed.

SpdfAdditionalMetadata::getType routine in spdfadditionalmetadata__define.pro

Gets the type value.

SpdfAdditionalMetadata::getUrl routine in spdfadditionalmetadata__define.pro

Gets the URL value.

SpdfAdditionalMetadata::init routine in spdfadditionalmetadata__define.pro

Creates an SpdfAdditionalMetadata object.

SpdfAdditionalMetadata::print routine in spdfadditionalmetadata__define.pro

Prints a textual representation of this object.

SpdfAdditionalMetadata__define routine in spdfadditionalmetadata__define.pro

Defines the SpdfAdditionalMetadata class.

spdfadditionalmetadata__define.pro .pro file in ./ directory

This class is an IDL representation of the AdditionalMetadata element from the Coordinated Data Analysis System (CDAS) XML schema.

SpdfAuthenticator class
SpdfAuthenticator::addToCachedCredentials routine in spdfauthenticator__define.pro

Adds the given credentials for the specified dataview to the cache.

SpdfAuthenticator::cacheCredentials routine in spdfauthenticator__define.pro

Stores the given credentials for the specified dataview in the cache.

SpdfAuthenticator::cleanup routine in spdfauthenticator__define.pro

Performs cleanup operations when this object is destroyed.

SpdfAuthenticator::getCachedCredentials routine in spdfauthenticator__define.pro

Gets the cached credentials for the specified dataview.

SpdfAuthenticator::getCredentials routine in spdfauthenticator__define.pro

Obtains the user's authentication credentials to access the specified dataview.

SpdfAuthenticator::init routine in spdfauthenticator__define.pro

Creates an SpdfAuthenticator object.

SpdfAuthenticator__define routine in spdfauthenticator__define.pro

Defines the SpdfAuthenticator class.

spdfauthenticator__define.pro .pro file in ./ directory

This class represents an object that knows how to obtain authentication for the Coordinated Data Analysis System (CDAS).

SpdfBinData class
SpdfBinData::cleanup routine in spdfbindata__define.pro

Performs cleanup operations when this object is destroyed.

SpdfBinData::createDomElement routine in spdfbindata__define.pro

Creates a BinData element using the given XML DOM document with the values of this object.

SpdfBinData::getInterpolateMissingValues routine in spdfbindata__define.pro

Gets the interpolateMissingValues value.

SpdfBinData::getInterval routine in spdfbindata__define.pro

Gets the interval value.

SpdfBinData::getOverrideDefaultBinning routine in spdfbindata__define.pro

Gets the overrideDefaultBinning value.

SpdfBinData::getSigmaMultiplier routine in spdfbindata__define.pro

Gets the sigmaMultiplier value.

SpdfBinData::init routine in spdfbindata__define.pro

Creates an SpdfBinData object.

SpdfBinData__define routine in spdfbindata__define.pro
spdfbindata__define.pro .pro file in ./ directory

This class is an IDL representation of the BinData element from the Coordinated Data Analysis System (CDAS) XML schema.

spdfBinDataButton routine in spdfcdawebchooser.pro

Responds to a "bin data" button event.

spdfBinDataWindow routine in spdfcdawebchooser.pro

Responds to a request to set data binning parameters.

spdfBinHelp routine in spdfcdawebchooser.pro

Responds to a request to view the binning help.

spdfBinMissingValues routine in spdfcdawebchooser.pro

Responds to a "bin missing values" button event.

spdfBinOverrideDefaultBinning routine in spdfcdawebchooser.pro

Responds to a "bin override default binning" button event.

SpdfCdas class
SpdfCdas::cleanup routine in spdfcdas__define.pro

Performs cleanup operations when this object is destroyed.

SpdfCdas::download routine in spdfcdas__define.pro

Downloads the specified remote files and returns their local filenames.

SpdfCdas::encode routine in spdfcdas__define.pro

"Percent encodes" the given string to escape reserved charaters.

SpdfCdas::getCdawlibData routine in spdfcdas__define.pro

Gets data from the specified dataset and returns it in a CDAWlib structure.

SpdfCdas::getCdfData routine in spdfcdas__define.pro

Gets Common Data Format data from the specified dataset.

SpdfCdas::getCdfDataHash routine in spdfcdas__define.pro

Gets data from the specified dataset and returns it in an IDL Hash as defined by the CDF_READCDF function.

SpdfCdas::getCurrentVersion routine in spdfcdas__define.pro

Gets the most up to date version of this class.

SpdfCdas::getData routine in spdfcdas__define.pro

Make a request to CDAS for the specified data.

SpdfCdas::getDataResult routine in spdfcdas__define.pro

Creates an SpdfCdasDataResult object from the given cdas:DataResult XML document.

SpdfCdas::getDataResultText routine in spdfcdas__define.pro

Gets the specified node values from the given cdas:DataResult XML document.

SpdfCdas::getDatasets routine in spdfcdas__define.pro

Gets a description of all the datasets.

SpdfCdas::getDataviews routine in spdfcdas__define.pro

Gets a description of all the dataviews that are available.

SpdfCdas::getDefaultDataview routine in spdfcdas__define.pro

Gets the current defaultDataview value.

SpdfCdas::getEndpoint routine in spdfcdas__define.pro

Gets the current endpoint value.

SpdfCdas::getExampleTimeInterval routine in spdfcdas__define.pro

Gets a small example time interval for the specified dataset.

SpdfCdas::getFileDescriptions routine in spdfcdas__define.pro

Creates SpdfFileDescription object(s) from the FileDescription elements in the given cdas:DataResult XML document.

SpdfCdas::getGraphData routine in spdfcdas__define.pro

Gets a graphical representation of data from the specified dataset.

SpdfCdas::getInstrumentTypes routine in spdfcdas__define.pro

Gets a description of all the instrument types.

SpdfCdas::getInventory routine in spdfcdas__define.pro

Gets a description of a dataset's data inventory.

SpdfCdas::getJulDate routine in spdfcdas__define.pro

Creates a julday object from the given time element from a cdas:DataResult XML document.

SpdfCdas::getNamedElementsFirstChildValue routine in spdfcdas__define.pro

Gets the node's value of the first child of the first item of the specified element of the given DOM document.

SpdfCdas::getObservatoryGroups routine in spdfcdas__define.pro

Gets a description of all the observatory groups.

SpdfCdas::getRequestUrl routine in spdfcdas__define.pro

Create an IDLnetURL object from the given URL with any supplied authentication values set.

SpdfCdas::getResponseHeader routine in spdfcdas__define.pro

Function to get an HTTP response header.

SpdfCdas::getTextData routine in spdfcdas__define.pro

Gets a textual representation of data from the specified dataset.

SpdfCdas::getThumbnailDescription routine in spdfcdas__define.pro

Creates an SpdfThumbnailDescription object from the FileDescription element in the given cdas:DataResult XML document.

SpdfCdas::getThumbnailId routine in spdfcdas__define.pro

Gets the ThumbnailId value from the given cdas:FileDescription element.

SpdfCdas::getTimeInterval routine in spdfcdas__define.pro

Creates a SpdfTimeInterval object from the given TimeInterval element from a cdas:DataResult XML document.

SpdfCdas::getTimeIntervalChild routine in spdfcdas__define.pro

Creates a SpdfTimeInterval object from a child TimeInterval element of the given node from a cdas:DataResult XML document.

SpdfCdas::getUserAgent routine in spdfcdas__define.pro

Gets the current userAgent value.

SpdfCdas::getVariableNames routine in spdfcdas__define.pro

Gets the names of a dataset's variables.

SpdfCdas::getVariables routine in spdfcdas__define.pro

Gets a description of a dataset's variables.

SpdfCdas::getVersion routine in spdfcdas__define.pro

Gets the version of this class.

SpdfCdas::handleHttpError routine in spdfcdas__define.pro

Function to handle HTTP request errors.

SpdfCdas::init routine in spdfcdas__define.pro

Creates an object representing CDAS.

SpdfCdas::isUpToDate routine in spdfcdas__define.pro

Compares getVersion() and getCurrentVersion() to determine if this class is up to date.

SpdfCdas::julDay2Iso8601 routine in spdfcdas__define.pro

Converts the given Julian Day value to an ISO 8601 string representation.

SpdfCdas::makeGetRequest routine in spdfcdas__define.pro

Perform an HTTP GET request to the given URL.

SpdfCdas::makePostRequest routine in spdfcdas__define.pro

Perform an HTTP POST request to the given URL.

SpdfCdas__define routine in spdfcdas__define.pro

Defines the SpdfCdas class.

spdfcdas__define.pro .pro file in ./ directory

This class represents the remotely callable interface to NASA's Space Physics Data Facility (SPDF) Coordinated Data Analysis System (CDAS).

SpdfCdasDataRequest class
SpdfCdasDataRequest::cleanup routine in spdfcdasdatarequest__define.pro

Performs cleanup operations when this object is destroyed.

SpdfCdasDataRequest::createDomElement routine in spdfcdasdatarequest__define.pro

Creates a DataRequest element using the given XML DOM document with the values of this object.

SpdfCdasDataRequest::getDataRequestEntity routine in spdfcdasdatarequest__define.pro

Gets the data-request entity.

SpdfCdasDataRequest::init routine in spdfcdasdatarequest__define.pro

Creates an SpdfCdasDataRequest object.

SpdfCdasDataRequest__define routine in spdfcdasdatarequest__define.pro

Defines the SpdfCdasDataRequest class.

spdfcdasdatarequest__define.pro .pro file in ./ directory

This class is an IDL representation of the DataRequest element from the Coordinated Data Analysis System (CDAS) XML schema.

SpdfCdasDataResult class
SpdfCdasDataResult::cleanup routine in spdfcdasdataresult__define.pro

Performs cleanup operations when this object is destroyed.

SpdfCdasDataResult::getErrors routine in spdfcdasdataresult__define.pro

Gets the errors.

SpdfCdasDataResult::getFileDescriptions routine in spdfcdasdataresult__define.pro

Gets the SpdfFileDescriptions.

SpdfCdasDataResult::getMessages routine in spdfcdasdataresult__define.pro

Gets the messages.

SpdfCdasDataResult::getStatuses routine in spdfcdasdataresult__define.pro

Gets the statuses.

SpdfCdasDataResult::getWarnings routine in spdfcdasdataresult__define.pro

Gets the warnings.

SpdfCdasDataResult::init routine in spdfcdasdataresult__define.pro

Creates an SpdfCdasDataResult object.

SpdfCdasDataResult::print routine in spdfcdasdataresult__define.pro

Prints a textual representation of this object.

SpdfCdasDataResult__define routine in spdfcdasdataresult__define.pro

Defines the SpdfCdasDataResult class.

spdfcdasdataresult__define.pro .pro file in ./ directory

This class is an IDL representation of the DataResult element from the Coordinated Data Analysis System (CDAS) XML schema.

SpdfCdasWsExample routine in spdfcdaswsexample.pro

This procedure is an example to demonstrate calling the CDAS REST Web Services from an IDL program.

spdfcdaswsexample.pro .pro file in ./ directory

This program is an example to demonstrate calling the Coordinated Data Analysis System's REST Web Services from an Exelis Visual Information Solutions (VIS) Interactive Data Language (IDL) program.

spdfCdawebChooser routine in spdfcdawebchooser.pro

Provides a GUI for choosing and retrieving data from CDAWeb.

spdfcdawebchooser.pro .pro file in ./ directory

This program provides a GUI for choosing datasets from CDAWeb.

SpdfCdawebChooserAuthenticator class
SpdfCdawebChooserAuthenticator::cleanup routine in spdfcdawebchooserauthenticator__define.pro

Performs cleanup operations when this object is destroyed.

SpdfCdawebChooserAuthenticator::getCredentials routine in spdfcdawebchooserauthenticator__define.pro

Obtains the user's authentication credentials to access the specified dataview.

SpdfCdawebChooserAuthenticator::init routine in spdfcdawebchooserauthenticator__define.pro

Creates an SpdfCdawebChooserAuthenticator object.

SpdfCdawebChooserAuthenticator__define routine in spdfcdawebchooserauthenticator__define.pro

Defines the SpdfCdawebChooserAuthenticator class.

spdfcdawebchooserauthenticator__define.pro .pro file in ./ directory

This class is the SpdfCdawebChooser's specialization of an SpdfCdawebChooserAuthenticator.

spdfCdfEpoch2Julday routine in spdfcdawebchooser.pro
SpdfCdfRequest class
SpdfCdfRequest::cleanup routine in spdfcdfrequest__define.pro

Performs cleanup operations when this object is destroyed.

SpdfCdfRequest::createDomElement routine in spdfcdfrequest__define.pro

Creates a CdfRequest element using the given XML DOM document with the values of this object.

SpdfCdfRequest::getBinData routine in spdfcdfrequest__define.pro

Gets the binData parameters.

SpdfCdfRequest::getCdfFormat routine in spdfcdfrequest__define.pro

Gets the CDF format.

SpdfCdfRequest::getCdfVersion routine in spdfcdfrequest__define.pro

Gets the CDF version.

SpdfCdfRequest::getDatasetRequest routine in spdfcdfrequest__define.pro

Gets the dataset request.

SpdfCdfRequest::getTimeIntervals routine in spdfcdfrequest__define.pro

Gets the time intervals.

SpdfCdfRequest::init routine in spdfcdfrequest__define.pro

Creates an SpdfCdfRequest object.

SpdfCdfRequest__define routine in spdfcdfrequest__define.pro

Defines the SpdfCdfRequest class.

spdfcdfrequest__define.pro .pro file in ./ directory

This class is an IDL representation of the CdfRequest element from the Coordinated Data Analysis System (CDAS) XML schema.

spdfCloseBinWindow routine in spdfcdawebchooser.pro

Responds to a close bin data window event.

spdfCloseInventory routine in spdfcdawebchooser.pro

Responds to an inventory window close event.

spdfCreateCdawebListing routine in spdfcdawebchooser.pro

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

SpdfDatasetDescription class
SpdfDatasetDescription::cleanup routine in spdfdatasetdescription__define.pro

Performs cleanup operations when this object is destroyed.

SpdfDatasetDescription::getAdditionalMetadata routine in spdfdatasetdescription__define.pro

Gets the additional metadata.

SpdfDatasetDescription::getDatasetLinks routine in spdfdatasetdescription__define.pro

Gets the links.

SpdfDatasetDescription::getDoi routine in spdfdatasetdescription__define.pro

Gets the doi value.

SpdfDatasetDescription::getId routine in spdfdatasetdescription__define.pro

Gets the id value.

SpdfDatasetDescription::getInstruments routine in spdfdatasetdescription__define.pro

Gets the instruments.

SpdfDatasetDescription::getInstrumentsTypes routine in spdfdatasetdescription__define.pro

Gets the instrumentTypes.

SpdfDatasetDescription::getLabel routine in spdfdatasetdescription__define.pro

Gets the label value.

SpdfDatasetDescription::getNotes routine in spdfdatasetdescription__define.pro

Gets the notes value.

SpdfDatasetDescription::getObservatories routine in spdfdatasetdescription__define.pro

Gets the observatories.

SpdfDatasetDescription::getObservatoryGroups routine in spdfdatasetdescription__define.pro

Gets the observatoryGroups.

SpdfDatasetDescription::getPiAffiliation routine in spdfdatasetdescription__define.pro

Gets the Principal Investigator's affilation value.

SpdfDatasetDescription::getPiName routine in spdfdatasetdescription__define.pro

Gets the Principal Investigator value.

SpdfDatasetDescription::getResourceId routine in spdfdatasetdescription__define.pro

Gets the resourceId value.

SpdfDatasetDescription::getTimeInterval routine in spdfdatasetdescription__define.pro

Gets the TimeInterval value.

SpdfDatasetDescription::init routine in spdfdatasetdescription__define.pro

Creates an SpdfDatasetDescription object.

SpdfDatasetDescription::print routine in spdfdatasetdescription__define.pro

Prints a textual representation of this object.

SpdfDatasetDescription__define routine in spdfdatasetdescription__define.pro

Defines the SpdfDatasetDescription class.

spdfdatasetdescription__define.pro .pro file in ./ directory

This class is an IDL representation of the DatasetDescription element from the Coordinated Data Analysis System (CDAS) XML schema.

SpdfDatasetLink class
SpdfDatasetLink::cleanup routine in spdfdatasetlink__define.pro

Performs cleanup operations when this object is destroyed.

SpdfDatasetLink::getText routine in spdfdatasetlink__define.pro

Gets the text value.

SpdfDatasetLink::getTitle routine in spdfdatasetlink__define.pro

Gets the title value.

SpdfDatasetLink::getUrl routine in spdfdatasetlink__define.pro

Gets the URL value.

SpdfDatasetLink::init routine in spdfdatasetlink__define.pro

Creates an SpdfDatasetLink object.

SpdfDatasetLink::print routine in spdfdatasetlink__define.pro

Prints a textual representation of this object.

SpdfDatasetLink__define routine in spdfdatasetlink__define.pro

Defines the SpdfDatasetLink class.

spdfdatasetlink__define.pro .pro file in ./ directory

This class is an IDL representation of the DatasetLink element from the Coordinated Data Analysis System (CDAS) XML schema.

SpdfDatasetRequest class
SpdfDatasetRequest::cleanup routine in spdfdatasetrequest__define.pro

Performs cleanup operations when this object is destroyed.

SpdfDatasetRequest::createDomElement routine in spdfdatasetrequest__define.pro

Creates a DataRequest element using the given XML DOM document with the values of this object.

SpdfDatasetRequest::getDatasetId routine in spdfdatasetrequest__define.pro

Gets the dataset identifier.

SpdfDatasetRequest::getVariableNames routine in spdfdatasetrequest__define.pro

Get the variable names.

SpdfDatasetRequest::init routine in spdfdatasetrequest__define.pro

Creates an SpdfDatasetRequest object.

SpdfDatasetRequest__define routine in spdfdatasetrequest__define.pro

Defines the SpdfDatasetRequest class.

spdfdatasetrequest__define.pro .pro file in ./ directory

This class is an IDL representation of the DatasetRequest element from the Coordinated Data Analysis System (CDAS) XML schema.

spdfDatasetTreeEvent routine in spdfcdawebchooser.pro

Responds to a dataset tree event.

SpdfDataviewDescription class
SpdfDataviewDescription::getEndpointAddress routine in spdfdataviewdescription__define.pro

Gets the endpointAddress.

SpdfDataviewDescription::getId routine in spdfdataviewdescription__define.pro

Gets the identifier.

SpdfDataviewDescription::getNoticeUrl routine in spdfdataviewdescription__define.pro

Gets the notice URL.

SpdfDataviewDescription::getOverview routine in spdfdataviewdescription__define.pro

Gets the overview description.

SpdfDataviewDescription::getPublicAccess routine in spdfdataviewdescription__define.pro

Gets the public-access flag.

SpdfDataviewDescription::getSubtitle routine in spdfdataviewdescription__define.pro

Gets the sub-title.

SpdfDataviewDescription::getTitle routine in spdfdataviewdescription__define.pro

Gets the title.

SpdfDataviewDescription::getUnderConstruction routine in spdfdataviewdescription__define.pro

Gets the underConstruction flag.

SpdfDataviewDescription::init routine in spdfdataviewdescription__define.pro

Creates an SpdfDataviewDescription object.

SpdfDataviewDescription::print routine in spdfdataviewdescription__define.pro

Prints a textual representation of this object.

SpdfDataviewDescription__define routine in spdfdataviewdescription__define.pro

Defines the SpdfDataviewDescription class.

spdfdataviewdescription__define.pro .pro file in ./ directory

This class is an IDL representation of the DataviewDescription element from the Coordinated Data Analysis System (CDAS) XML schema.

spdfDataviewSelected routine in spdfcdawebchooser.pro

Responds to a "dataview selected" event.

spdfDefaultTime routine in spdfcdawebchooser.pro

Responds to a request to set a default time value.

spdfExit routine in spdfcdawebchooser.pro

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

SpdfFileDescription class
SpdfFileDescription::cleanup routine in spdffiledescription__define.pro

Performs cleanup operations when this object is destroyed.

SpdfFileDescription::getFile routine in spdffiledescription__define.pro

Retrieves this file from a remote HTTP or FTP server and writes it to disk, a memory buffer, or an array of strings.

SpdfFileDescription::getLastModified routine in spdffiledescription__define.pro

Gets date the file was last modified.

SpdfFileDescription::getLength routine in spdffiledescription__define.pro

Gets the file's length (in bytes).

SpdfFileDescription::getMimeType routine in spdffiledescription__define.pro

Gets the MIME-type of file.

SpdfFileDescription::getName routine in spdffiledescription__define.pro

Gets the file's name.

SpdfFileDescription::getThumbnailDescription routine in spdffiledescription__define.pro

Gets thumbnail description.

SpdfFileDescription::getThumbnailId routine in spdffiledescription__define.pro

Gets thumbnail identifier.

SpdfFileDescription::getTimeInterval routine in spdffiledescription__define.pro

Gets time interval of data in file.

SpdfFileDescription::init routine in spdffiledescription__define.pro

Creates an SpdfFileDescription object.

SpdfFileDescription::print routine in spdffiledescription__define.pro

Prints a textual representation of this object.

SpdfFileDescription__define routine in spdffiledescription__define.pro

Defines the SpdfFileDescription class.

spdffiledescription__define.pro .pro file in ./ directory

This class is an IDL representation of the FileDescription element from the Coordinated Data Analysis System (CDAS) XML schema.

spdfFindDatasets routine in spdfcdawebchooser.pro

Responds to an event that initiates a search for datasets that satisfies the users previous selections.

spdfGetBinData routine in spdfcdawebchooser.pro

Gets the BinData value from the associated widgets.

spdfGetCdawebData routine in spdfcdawebchooser.pro

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

spdfGetCdawebDataCmd routine in spdfcdawebchooser.pro

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

spdfGetCdawebDataExec routine in spdfcdawebchooser.pro

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

spdfGetCdawebDataIdl routine in spdfcdawebchooser.pro

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

spdfGetCdawebPlot routine in spdfcdawebchooser.pro

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

SpdfGetData routine in spdfgetdata.pro

This function gets data from NASA's Space Physics Data Facility Coordinated Data Analysis System and returns it in a CDAWlib structure..

spdfgetdata.pro .pro file in ./ directory

This file contains a procedure-oriented wrapper that integrates functionality from the SpdfCdas class (IDL client interface to Coordinated Data Analysis System Web Services (CDAS WSs)) and the CDAWlib library.

SpdfGetDataCallback routine in spdfgetdata.pro

This function is an example of a callback_function for the spdfGetData function.

spdfGetDatasetDescription routine in spdfcdawebchooser.pro

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

spdfGetDatasetSelection routine in spdfcdawebchooser.pro

Gets the dataset and variable selection values.

spdfGetDataviews routine in spdfcdawebchooser.pro

Gets all dataview descriptions.

SpdfGetDefaultSslVerifyPeer routine in spdfgetdefaultsslverifypeer.pro

Gets the default value for the IDLnetURL SSL_VERIFY_PEER property based upon the runtime version of IDL.

spdfgetdefaultsslverifypeer.pro .pro file in ./ directory
spdfGetSpecifiedTime routine in spdfcdawebchooser.pro

Gets the specified time interval.

SpdfGraphRequest class
SpdfGraphRequest::cleanup routine in spdfgraphrequest__define.pro

Performs cleanup operations when this object is destroyed.

SpdfGraphRequest::createDomElement routine in spdfgraphrequest__define.pro

Creates a GraphRequest element using the given XML DOM document with the values of this object.

SpdfGraphRequest::getBinData routine in spdfgraphrequest__define.pro

Gets the binData parameters.

SpdfGraphRequest::getDatasetRequests routine in spdfgraphrequest__define.pro

Gets the dataset information of this request.

SpdfGraphRequest::getGraphOptions routine in spdfgraphrequest__define.pro

Gets the graph options of this request.

SpdfGraphRequest::getImageFormats routine in spdfgraphrequest__define.pro

Gets the image formats of this request.

SpdfGraphRequest::getTimeInterval routine in spdfgraphrequest__define.pro

Gets the time interval of this request.

SpdfGraphRequest::init routine in spdfgraphrequest__define.pro

Creates an SpdfGraphRequest object.

SpdfGraphRequest__define routine in spdfgraphrequest__define.pro

Defines the SpdfGraphRequest class.

spdfgraphrequest__define.pro .pro file in ./ directory

This class is an IDL representation of the GraphRequest element from the Coordinated Data Analysis System (CDAS) XML schema.

SpdfHttpErrorDialog class
SpdfHttpErrorDialog::cleanup routine in spdfhttperrordialog__define.pro

Performs cleanup operations when this object is destroyed.

SpdfHttpErrorDialog::init routine in spdfhttperrordialog__define.pro

Creates an SpdfHttpErrorDialog object.

SpdfHttpErrorDialog::reportError routine in spdfhttperrordialog__define.pro

This procedure is called when an HTTP error occurs.

SpdfHttpErrorDialog__define routine in spdfhttperrordialog__define.pro

Defines the SpdfHttpErrorDialog class.

spdfhttperrordialog__define.pro .pro file in ./ directory

This class represents an object that is used to report HTTP errors.

SpdfHttpErrorReporter::cleanup routine in spdfhttperrorreporter__define.pro

Performs cleanup operations when this object is destroyed.

SpdfHttpErrorReporter::getRetryAfterTime routine in spdfhttperrorreporter__define.pro

Gets the retryAfterTime value.

SpdfHttpErrorReporter::init routine in spdfhttperrorreporter__define.pro

Creates an SpdfHttpErrorReporter object.

SpdfHttpErrorReporter::printResponse routine in spdfhttperrorreporter__define.pro

This procedure prints some diagnostic information from the given HTTP error response file.

SpdfHttpErrorReporter::reportError routine in spdfhttperrorreporter__define.pro

This procedure is called when an HTTP error occurs.

SpdfHttpErrorReporter::waitUntilRetryAfterTime routine in spdfhttperrorreporter__define.pro

Suspends execution until after any retryAfterTime.

SpdfHttpErrorReporter__define routine in spdfhttperrorreporter__define.pro

Defines the SpdfHttpErrorReporter class.

spdfhttperrorreporter__define.pro .pro file in ./ directory

This class represents an object that is used to report HTTP errors.
Notes:

  1. This class exists in both the CDAS and SSC web service IDL libraries.

SpdfHttpProxy class
SpdfHttpProxy::cleanup routine in spdfhttpproxy__define.pro

Performs cleanup operations when this object is destroyed.

SpdfHttpProxy::getAuthentication routine in spdfhttpproxy__define.pro

Gets the authentication value.

SpdfHttpProxy::getHostname routine in spdfhttpproxy__define.pro

Gets the hostname value.

SpdfHttpProxy::getPassword routine in spdfhttpproxy__define.pro

Gets the password value.

SpdfHttpProxy::getPort routine in spdfhttpproxy__define.pro

Gets the port value.

SpdfHttpProxy::getUsername routine in spdfhttpproxy__define.pro

Gets the username value.

SpdfHttpProxy::init routine in spdfhttpproxy__define.pro

Creates an SpdfHttpProxy object with values suitable for use with the IDLnetURL object.

SpdfHttpProxy::setAuthentication routine in spdfhttpproxy__define.pro

Sets the authentication value.

SpdfHttpProxy::setHostname routine in spdfhttpproxy__define.pro

Sets the hostname value.

SpdfHttpProxy::setPassword routine in spdfhttpproxy__define.pro

Sets the password value.

SpdfHttpProxy::setPort routine in spdfhttpproxy__define.pro

Sets the port value.

SpdfHttpProxy::setUsername routine in spdfhttpproxy__define.pro

Sets the username value.

SpdfHttpProxy__define routine in spdfhttpproxy__define.pro
spdfhttpproxy__define.pro .pro file in ./ directory

This class represent HTTP proxy settings.

spdfIgnoreSelected routine in spdfcdawebchooser.pro

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

SpdfInstrumentTypeDescription class
SpdfInstrumentTypeDescription::cleanup routine in spdfinstrumenttypedescription__define.pro

Performs cleanup operations when this object is destroyed.

SpdfInstrumentTypeDescription::getName routine in spdfinstrumenttypedescription__define.pro

Gets the name.

SpdfInstrumentTypeDescription::init routine in spdfinstrumenttypedescription__define.pro

Creates an SpdfInstrumentTypeDescription object.

SpdfInstrumentTypeDescription::print routine in spdfinstrumenttypedescription__define.pro

Prints a textual representation of this object.

SpdfInstrumentTypeDescription__define routine in spdfinstrumenttypedescription__define.pro

Defines the SpdfInstrumentTypeDescription class.

spdfinstrumenttypedescription__define.pro .pro file in ./ directory

This class is an IDL representation of the InstrumentTypeDescription element from the Coordinated Data Analysis System (CDAS) XML schema.

SpdfInventoryDescription class
SpdfInventoryDescription::cleanup routine in spdfinventorydescription__define.pro

Performs cleanup operations when this object is destroyed.

SpdfInventoryDescription::getId routine in spdfinventorydescription__define.pro

Gets the dataset identifier.

SpdfInventoryDescription::getTimeIntervals routine in spdfinventorydescription__define.pro

Gets the time intervals when data is available.

SpdfInventoryDescription::init routine in spdfinventorydescription__define.pro

Creates an SpdfInventoryDescription object.

SpdfInventoryDescription__define routine in spdfinventorydescription__define.pro

Defines the SpdfInventoryDescription class.

spdfinventorydescription__define.pro .pro file in ./ directory

This class is an IDL representation of the InventoryDescription element from the Coordinated Data Analysis System (CDAS) XML schema.

spdfIsValidDate routine in spdfcdawebchooser.pro

Determines if the given string is a valid date/time value.

SpdfObservatoryGroupDescription class
SpdfObservatoryGroupDescription::cleanup routine in spdfobservatorygroupdescription__define.pro

Performs cleanup operations when this object is destroyed.

SpdfObservatoryGroupDescription::getName routine in spdfobservatorygroupdescription__define.pro

Gets the name of this group.

SpdfObservatoryGroupDescription::getObservatoryIds routine in spdfobservatorygroupdescription__define.pro

Gets the IDs of observatories belonging to this group

SpdfObservatoryGroupDescription::init routine in spdfobservatorygroupdescription__define.pro

Creates an SpdfObservatoryGroupDescription object.

SpdfObservatoryGroupDescription::print routine in spdfobservatorygroupdescription__define.pro

Prints a textual representation of this object.

SpdfObservatoryGroupDescription__define routine in spdfobservatorygroupdescription__define.pro

Defines the SpdfObservatoryGroupDescription class.

spdfobservatorygroupdescription__define.pro .pro file in ./ directory

This class is an IDL representation of the ObservatoryGroupDescription element from the Coordinated Data Analysis System (CDAS) XML schema.

spdfReadLocalData routine in spdfcdawebchooser.pro

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

spdfSaveDataButton routine in spdfcdawebchooser.pro

Responds to a "save data" button event.

spdfSelectDataview routine in spdfcdawebchooser.pro

Selects a dataview.

spdfShowAsOnlineHelp routine in spdfcdawebchooser.pro

Displays the given URL using the IDL ONLINE_HELP procedure.

spdfSpikeRemovalHelp routine in spdfcdawebchooser.pro

Responds to a request to view the spike removal help.

spdfSpikeRemovalSelected routine in spdfcdawebchooser.pro

Responds to a "spike removal selected" event.

SpdfTextRequest class
SpdfTextRequest::cleanup routine in spdftextrequest__define.pro

Performs cleanup operations when this object is destroyed.

SpdfTextRequest::createDomElement routine in spdftextrequest__define.pro

Creates a TextRequest element using the given XML DOM document with the values of this object.

SpdfTextRequest::getBinData routine in spdftextrequest__define.pro

Gets the binData parameters.

SpdfTextRequest::getCompression routine in spdftextrequest__define.pro

Gets the compression options.

SpdfTextRequest::getDatasetRequest routine in spdftextrequest__define.pro

Gets the dataset information.

SpdfTextRequest::getFormat routine in spdftextrequest__define.pro

Gets the format option.

SpdfTextRequest::getTimeInterval routine in spdftextrequest__define.pro

Gets the time interval of this request.

SpdfTextRequest::init routine in spdftextrequest__define.pro

Creates an SpdfTextRequest object.

SpdfTextRequest__define routine in spdftextrequest__define.pro

Defines the SpdfTextRequest class.

spdftextrequest__define.pro .pro file in ./ directory

This class is an IDL representation of the TextRequest element from the Coordinated Data Analysis System (CDAS) XML schema.

SpdfThumbnailDescription class
SpdfThumbnailDescription::cleanup routine in spdfthumbnaildescription__define.pro

Performs cleanup operations when this object is destroyed.

SpdfThumbnailDescription::getDataset routine in spdfthumbnaildescription__define.pro

Gets the dataset value.

SpdfThumbnailDescription::getNumCols routine in spdfthumbnaildescription__define.pro

Gets the number of columns of thumbnail images.

SpdfThumbnailDescription::getNumFrames routine in spdfthumbnaildescription__define.pro

Gets the number of frames.

SpdfThumbnailDescription::getNumRows routine in spdfthumbnaildescription__define.pro

Gets the number of rows of thumbnail images.

SpdfThumbnailDescription::getThumbnailHeight routine in spdfthumbnaildescription__define.pro

Gets the height of each thumbnail image.

SpdfThumbnailDescription::getThumbnailWidth routine in spdfthumbnaildescription__define.pro

Gets the width of each thumbnail image.

SpdfThumbnailDescription::getTitleHeight routine in spdfthumbnaildescription__define.pro

Gets the height of the title.

SpdfThumbnailDescription::init routine in spdfthumbnaildescription__define.pro

Creates an SpdfThumbnailDescription object.

SpdfThumbnailDescription__define routine in spdfthumbnaildescription__define.pro

Defines the SpdfThumbnailDescription class.

spdfthumbnaildescription__define.pro .pro file in ./ directory

This class is an IDL representation of the ThumbnailDescription element from the Coordinated Data Analysis System (CDAS) XML schema.

SpdfTimeInterval class
SpdfTimeInterval::cleanup routine in spdftimeinterval__define.pro

Performs cleanup operations when this object is destroyed.

SpdfTimeInterval::createDomElement routine in spdftimeinterval__define.pro

Creates a TimeInterval element using the given XML DOM document with the values of this object.

SpdfTimeInterval::getCdawebStart routine in spdftimeinterval__define.pro

Get the start value.

SpdfTimeInterval::getCdawebStop routine in spdftimeinterval__define.pro

Get the stop value.

SpdfTimeInterval::getIso8601FromJulDay routine in spdftimeinterval__define.pro

Converts the given julday value into the corresponding ISO 8601 time value string.

SpdfTimeInterval::getIso8601Start routine in spdftimeinterval__define.pro

Get the start value.

SpdfTimeInterval::getIso8601Stop routine in spdftimeinterval__define.pro

Get the stop value.

SpdfTimeInterval::getJulDayFromIso8601 routine in spdftimeinterval__define.pro

Converts the given ISO 8601 time value string into the corresponding julday value.

SpdfTimeInterval::getStart routine in spdftimeinterval__define.pro

Get the start value.

SpdfTimeInterval::getStop routine in spdftimeinterval__define.pro

Get the stop value.

SpdfTimeInterval::init routine in spdftimeinterval__define.pro

Creates an SpdfTimeInterval object.

SpdfTimeInterval::isGreaterThan1Day routine in spdftimeinterval__define.pro

Determines if this interval is larger than one day.

SpdfTimeInterval::isStartLessThanStop routine in spdftimeinterval__define.pro

Determines if the start time is less than the stop time.

SpdfTimeInterval::print routine in spdftimeinterval__define.pro

Prints a textual representation of this object.

SpdfTimeInterval::setStart routine in spdftimeinterval__define.pro

Sets the start value.

SpdfTimeInterval::setStop routine in spdftimeinterval__define.pro

Sets the stop value.

SpdfTimeInterval__define routine in spdftimeinterval__define.pro

Defines the SpdfTimeInterval class.

spdftimeinterval__define.pro .pro file in ./ directory

This class is an IDL representation of the TimeInterval element from the Coordinated Data Analysis System (CDAS) and Satellite Situation Center (SSC) XML schemas.

SpdfVariableDescription class
SpdfVariableDescription::cleanup routine in spdfvariabledescription__define.pro

Performs cleanup operations when this object is destroyed.

SpdfVariableDescription::getLongDescription routine in spdfvariabledescription__define.pro

Gets the long description of this variable.

SpdfVariableDescription::getName routine in spdfvariabledescription__define.pro

Gets the name of this variable.

SpdfVariableDescription::getShortDescription routine in spdfvariabledescription__define.pro

Gets the short description of this variable.

SpdfVariableDescription::init routine in spdfvariabledescription__define.pro

Creates an SpdfVariableDescription object.

SpdfVariableDescription::print routine in spdfvariabledescription__define.pro

Prints a textual representation of this object.

SpdfVariableDescription__define routine in spdfvariabledescription__define.pro

Defines the SpdfVariableDescription class.

spdfvariabledescription__define.pro .pro file in ./ directory

This class is an IDL representation of the VariableDescription element from the Coordinated Data Analysis System (CDAS) XML schema.

spdfViewDoi routine in spdfcdawebchooser.pro

Responds to a request to view a dataset's DOI/SPASE description.

spdfViewInventory routine in spdfcdawebchooser.pro

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

spdfViewNotes routine in spdfcdawebchooser.pro

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

ssl_verify_peer field in class SpdfCdas

IDLnetURL SSL_VERIFY_PEER property value.

sslVerifyPeer keyword in routine SpdfCdas::init in file spdfcdas__define.pro

Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer property in class SpdfCdas
sslVerifyPeer keyword in routine getTextFile in file spdfcdaswsexample.pro

Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer keyword in routine getFile in file spdfcdaswsexample.pro

Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer keyword in routine getResultFile in file spdfcdaswsexample.pro

Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer keyword in routine getDataResults in file spdfcdaswsexample.pro

Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer keyword in routine SpdfCdasWsExample in file spdfcdaswsexample.pro

Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer keyword in routine spdfCdawebChooser in file spdfcdawebchooser.pro

Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer keyword in routine SpdfFileDescription::getFile in file spdffiledescription__define.pro

Specifies whether the authenticity of the peer's SSL certificate should be verified.

sslVerifyPeer keyword in routine SpdfGetData in file spdfgetdata.pro

Specifies whether the authenticity of the peer's SSL certificate should be verified.

start field in class SpdfTimeInterval

julday start value of interval.

start parameter in routine SpdfTimeInterval::init in file spdftimeinterval__define.pro

start time of interval.

startDate keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

value that restricts the returned dataset to only those that contain data after this date.

startRecord field in class SpdfThumbnailDescription

startRecord parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

startTimeWidget parameter in routine spdfGetSpecifiedTime in file spdfcdawebchooser.pro

id of start time widget.

state parameter in routine spdfGetBinData in file spdfcdawebchooser.pro

widget program's state.

state parameter in routine spdfGetCdawebDataCmd in file spdfcdawebchooser.pro

widget program's state.

state parameter in routine spdfGetCdawebDataExec in file spdfcdawebchooser.pro

widget program's state.

statuses field in class SpdfCdasDataResult

statuses related to this result.

statuses keyword in routine SpdfCdasDataResult::init in file spdfcdasdataresult__define.pro

statuses related to this result.

statuses property in class SpdfCdasDataResult
statusInfo parameter in routine SpdfGetDataCallback in file spdfgetdata.pro

stop field in class SpdfTimeInterval

julday stop value of interval.

stop parameter in routine SpdfTimeInterval::init in file spdftimeinterval__define.pro

stop time of interval.

stopDate keyword in routine SpdfCdas::getDatasets in file spdfcdas__define.pro

value that restricts the returned dataset to only those that contain data before this date.

stopTimeWidget parameter in routine spdfGetSpecifiedTime in file spdfcdawebchooser.pro

id of stop time widget.

string_array keyword in routine SpdfFileDescription::getFile in file spdffiledescription__define.pro

set this keyword to treat the return value as an array of strings.

subtitle field in class SpdfDataviewDescription

sub-title.

subtitle parameter in routine SpdfDataviewDescription::init in file spdfdataviewdescription__define.pro

sub-title of dataview.

T

tagName parameter in routine SpdfCdas::getNamedElementsFirstChildValue in file spdfcdas__define.pro

A scalar string containing the tag name of the desired element.

text field in class SpdfDatasetLink

link text value.

text parameter in routine SpdfDatasetLink::init in file spdfdatasetlink__define.pro

link text value.

thumbnailDescription field in class SpdfFileDescription

description of thumbnail images when this file contains thumbnail images.

thumbnailDescription keyword in routine SpdfFileDescription::init in file spdffiledescription__define.pro

if file contains thumbnail images, then this describes them.

thumbnailDescription property in class SpdfFileDescription
thumbnailHeight field in class SpdfThumbnailDescription

height of thumbnail image in pixels.

thumbnailHeight parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

height of thumbnail image in pixels.

thumbnailId field in class SpdfFileDescription

thumbnail description identifier when this file contains thumbnail images.

thumbnailId keyword in routine SpdfFileDescription::init in file spdffiledescription__define.pro

if file contains thumbnail images, then this contains an opaque value that the server needs to provide full-sized versions of the images.

thumbnailId property in class SpdfFileDescription
thumbnailWidth field in class SpdfThumbnailDescription

width of thumbnail image in pixels.

thumbnailWidth parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

width of thumbnail image in pixels.

timeInterval keyword in routine SpdfCdas::getInventory in file spdfcdas__define.pro

TimeInteval to restrict return inventory.

timeInterval parameter in routine SpdfCdas::getTextData in file spdfcdas__define.pro

time range of data to get.

timeInterval parameter in routine SpdfCdas::getGraphData in file spdfcdas__define.pro

time range of data to get.

timeInterval parameter in routine spdfGetCdawebDataCmd in file spdfcdawebchooser.pro

time range of data to get.

timeInterval parameter in routine spdfGetCdawebDataExec in file spdfcdawebchooser.pro

time range of data to get.

timeInterval field in class SpdfDatasetDescription

time interval of this dataset.

timeInterval parameter in routine SpdfDatasetDescription::init in file spdfdatasetdescription__define.pro

time interval of this dataset.

timeInterval field in class SpdfFileDescription

time interval of data in file.

timeInterval parameter in routine SpdfFileDescription::init in file spdffiledescription__define.pro

time interval of the data in this file.

timeInterval field in class SpdfGraphRequest

time interval of this request.

timeInterval parameter in routine SpdfGraphRequest::init in file spdfgraphrequest__define.pro

time interval that the requested graph is to contain data for.

timeInterval field in class SpdfTextRequest

time interval of request.

timeInterval parameter in routine SpdfTextRequest::init in file spdftextrequest__define.pro

time interval of the data to include in result.

timeInterval field in class SpdfThumbnailDescription

timeInterval parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

time interval covered by the thumbnail images.

timeIntervalElement parameter in routine SpdfCdas::getTimeInterval in file spdfcdas__define.pro

element from a cdas:DataResult XML document.

timeIntervals parameter in routine SpdfCdas::getCdfData in file spdfcdas__define.pro

time intervals of data to get.

timeIntervals parameter in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

time intervals of data to get.

timeIntervals parameter in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

time intervals of data to get.

timeIntervals field in class SpdfCdfRequest

time intervals of this request.

timeIntervals parameter in routine SpdfCdfRequest::init in file spdfcdfrequest__define.pro

time intervals that the requested CDF is to contain data for.

timeIntervals field in class SpdfInventoryDescription

time intervals when data is available.

timeIntervals parameter in routine SpdfInventoryDescription::init in file spdfinventorydescription__define.pro

time intervals when data is available.

timeSpans parameter in routine SpdfGetData in file spdfgetdata.pro

ISO 8601 format strings of the start and stop times of the data to get.

title field in class SpdfDatasetLink

link title value.

title parameter in routine SpdfDatasetLink::init in file spdfdatasetlink__define.pro

link title value.

title field in class SpdfDataviewDescription

title.

title parameter in routine SpdfDataviewDescription::init in file spdfdataviewdescription__define.pro

title of dataview.

titleHeight field in class SpdfThumbnailDescription

height of title in pixels.

titleHeight parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

height of title in pixels.

tlb parameter in routine spdfSelectDataview in file spdfcdawebchooser.pro

widget id of top level base.

tlb field in class SpdfCdawebChooserAuthenticator

widet ID of top-level base widet.

tvimage routine in spdfcdawebchooser.pro
twinscolorbar routine in spdfcdawebchooser.pro
type field in class SpdfAdditionalMetadata

type of additional metadata.

type parameter in routine SpdfAdditionalMetadata::init in file spdfadditionalmetadata__define.pro

type of metadata.

type parameter in routine SpdfCdas::getDataResultText in file spdfcdas__define.pro

name of elements whose value is to be gotten.

type field in class SpdfThumbnailDescription

type parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

U

underConstruction field in class SpdfDataviewDescription

under-construction flag.

underConstruction parameter in routine SpdfDataviewDescription::init in file spdfdataviewdescription__define.pro

indicates whether the dataview is in the process of being constructed.

url field in class SpdfAdditionalMetadata

URL to additional metadata.

url parameter in routine SpdfAdditionalMetadata::init in file spdfadditionalmetadata__define.pro

URL to additional metadata.

url parameter in routine SpdfCdas::makeGetRequest in file spdfcdas__define.pro

URL of GET request to make.

url parameter in routine SpdfCdas::makePostRequest in file spdfcdas__define.pro

URL of GET request to make.

url parameter in routine SpdfCdas::getRequestUrl in file spdfcdas__define.pro

URL.

url parameter in routine spdfShowAsOnlineHelp in file spdfcdawebchooser.pro

URL of file to download and display with ONLINE_HELP.

url field in class SpdfDatasetLink

link URL value.

url parameter in routine SpdfDatasetLink::init in file spdfdatasetlink__define.pro

link URL value.

userAgent field in class SpdfCdas

HTTP user-agent value to use in communications with CDAS.

userAgent keyword in routine SpdfCdas::init in file spdfcdas__define.pro

HTTP user-agent value used in communications with CDAS.

userAgent property in class SpdfCdas
username parameter in routine SpdfAuthenticator::getCredentials in file spdfauthenticator__define.pro

user's name.

username parameter in routine SpdfAuthenticator::getCachedCredentials in file spdfauthenticator__define.pro

user's name.

username parameter in routine SpdfAuthenticator::cacheCredentials in file spdfauthenticator__define.pro

user's name.

username parameter in routine SpdfAuthenticator::addToCachedCredentials in file spdfauthenticator__define.pro

user's name.

username parameter in routine SpdfCdas::handleHttpError in file spdfcdas__define.pro

username value obtained by calling the given authenticator.

username parameter in routine SpdfCdas::getRequestUrl in file spdfcdas__define.pro

username.

username parameter in routine SpdfCdawebChooserAuthenticator::getCredentials in file spdfcdawebchooserauthenticator__define.pro

user's name.

USERNAME field in class SpdfHttpProxy
username keyword in routine SpdfHttpProxy::init in file spdfhttpproxy__define.pro

Username for authenticating with the proxy server.

username property in class SpdfHttpProxy

V

value parameter in routine SpdfCdas::encode in file spdfcdas__define.pro

the string to be encoded.

value parameter in routine SpdfCdas::julDay2Iso8601 in file spdfcdas__define.pro

Julian day value to convert.

value parameter in routine spdfIsValidDate in file spdfcdawebchooser.pro

value to be tested.

value parameter in routine SpdfHttpProxy::setAuthentication in file spdfhttpproxy__define.pro

new value.

value parameter in routine SpdfHttpProxy::setHostname in file spdfhttpproxy__define.pro

new value.

value parameter in routine SpdfHttpProxy::setPassword in file spdfhttpproxy__define.pro

new value.

value parameter in routine SpdfHttpProxy::setPort in file spdfhttpproxy__define.pro

new value.

value parameter in routine SpdfHttpProxy::setUsername in file spdfhttpproxy__define.pro

new value.

value parameter in routine SpdfTimeInterval::setStart in file spdftimeinterval__define.pro

new value

value parameter in routine SpdfTimeInterval::setStop in file spdftimeinterval__define.pro

new value

value parameter in routine SpdfTimeInterval::getJulDayFromIso8601 in file spdftimeinterval__define.pro

ISO 8601 date/time value

value parameter in routine SpdfTimeInterval::getIso8601FromJulDay in file spdftimeinterval__define.pro

julday value.

variableNames field in class SpdfDatasetRequest

variable names.

variableNames parameter in routine SpdfDatasetRequest::init in file spdfdatasetrequest__define.pro

names of variables.

variables parameter in routine SpdfCdas::getCdfData in file spdfcdas__define.pro

names of variable's whose data is being requested.

variables parameter in routine SpdfCdas::getTextData in file spdfcdas__define.pro

names of variable's whose data is being requested.

variables parameter in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

names of variable's whose data is being requested.

variables parameter in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

names of variable's whose data is being requested.

variables parameter in routine SpdfGetData in file spdfgetdata.pro

On entry, names of variables whose values are to be gotten.

varName field in class SpdfThumbnailDescription

varName parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro

varNames parameter in routine spdfGetCdawebDataCmd in file spdfcdawebchooser.pro

names of variables containing the desired data.

varNames parameter in routine spdfGetCdawebDataExec in file spdfcdawebchooser.pro

names of variables containing the desired data.

verbose keyword in routine SpdfCdas::getCdawlibData in file spdfcdas__define.pro

The VERBOSE keyword causes additional status and debugging information to be printed.

verbose keyword in routine SpdfCdas::getCdfDataHash in file spdfcdas__define.pro

The VERBOSE keyword causes additional status and debugging information to be printed.

verbose keyword in routine SpdfCdas::download in file spdfcdas__define.pro

The VERBOSE keyword causes additional status and debugging information to be printed.

verbose keyword in routine SpdfGetData in file spdfgetdata.pro

The VERBOSE keyword causes SpdfGetData to print additional status, debugging, and usage information.

version field in class SpdfCdas

identifies the version of this class.

W

warnings field in class SpdfCdasDataResult

warnings related to this result.

warnings keyword in routine SpdfCdasDataResult::init in file spdfcdasdataresult__define.pro

warnings related to this result.

warnings property in class SpdfCdasDataResult

X

xmlRequest parameter in routine SpdfCdas::makePostRequest in file spdfcdas__define.pro

XML entity body to be include in the request.

xyStep field in class SpdfThumbnailDescription

xyStep parameter in routine SpdfThumbnailDescription::init in file spdfthumbnaildescription__define.pro



CDAS Feedback.