![[attach.png]](../../idldoc-resources/attach.png)
external/spdfcdas/
spdfcdas__define.pro
This class represents the remotely callable interface to NASA's Space Physics Data Facility (SPDF) Coordinated Data Analysis System (CDAS).
Author information
- Author
B. Harris
- Copyright
Copyright (c) 2010-2013 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.
Class description for SpdfCdas
Properties
Properties in SpdfCdas
- defaultDataview init
- endpoint init
- userAgent init
Fields
Fields in SpdfCdas
- currentVersionUrl ''
URL to the file identifying the most up to date version of this class.
- defaultDataview ''
CDAS dataview to access when the dataview is not specified.
- endpoint ''
URL of CDAS web service.
- userAgent ''
HTTP user-agent value to use in communications with CDAS.
- version ''
identifies the version of this class.
Routines
Routines from spdfcdas__define.pro
result = SpdfCdas::init( [endpoint=string] [, userAgent=string] [, defaultDataview=string])Creates an object representing CDAS.
SpdfCdas::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfCdas::getEndpoint()Gets the current endpoint value.
result = SpdfCdas::getUserAgent()Gets the current userAgent value.
result = SpdfCdas::getDefaultDataview()Gets the current defaultDataview value.
result = SpdfCdas::getVersion()Gets the version of this class.
result = SpdfCdas::getCurrentVersion()Gets the most up to date version of this class.
result = SpdfCdas::isUpToDate()Compares getversion() and getCurrentversion() to determine if this class is up to date.
result = SpdfCdas::getNamedElementsFirstChildValue(domElement, tagName)Gets the node's value of the first child of the first item of the specified element of the given DOM document.
result = SpdfCdas::getDataviews( [httpErrorReporter=SpdfHttpErrorReporter])Gets a description of all the dataviews that are available.
result = SpdfCdas::getObservatoryGroups( [dataview=string] [, instrumentTypes=strarr] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])Gets a description of all the observatory groups.
result = SpdfCdas::getInstrumentTypes( [dataview=string] [, observatoryGroups=strarr] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])Gets a description of all the instrument types.
result = SpdfCdas::getDatasets( [dataview=string] [, observatoryGroups=strarr] [, instrumentTypes=strarr] [, observatories=strarr] [, instruments=strarr] [, startDate=julday] [, stopDate=julday] [, idPattern=string] [, labelPattern=string] [, notesPattern=string] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])Gets a description of all the datasets.
result = SpdfCdas::getInventory(dataset [, dataview=string] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])Gets a description of a dataset's data inventory.
result = SpdfCdas::getVariables(dataset [, dataview=string] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])Gets a description of a dataset's variables.
result = SpdfCdas::getCdfData(timeInterval, dataset, variables [, dataview=string] [, cdfVersion=int] [, cdfFormat=string] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])Gets Common Data Format data from the specified dataset.
result = SpdfCdas::getTextData(timeInterval, dataset, variables [, dataview=string] [, compression=int] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])Gets a textual representation of data from the specified dataset.
result = SpdfCdas::getGraphData(timeInterval, datasetRequests [, dataview=string] [, graphOptions=int] [, imageFormat=strarr] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])Gets a graphical representation of data from the specified dataset.
result = SpdfCdas::julDay2Iso8601(value)Converts the given Julian Day value to an ISO 8601 string representation.
result = SpdfCdas::getData(dataRequest [, dataview=string] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])Make a request to CDAS for the specified data.
result = SpdfCdas::getDataResult(doc)Creates an SpdfCdasDataResult object from the given cdas:DataResult XML document.
result = SpdfCdas::getFileDescriptions(doc)Creates SpdfFileDescription object(s) from the FileDescription elements in the given cdas:DataResult XML document.
result = SpdfCdas::getThumbnailDescription(fileElement)Creates an SpdfThumbnailDescription object from the FileDescription element in the given cdas:DataResult XML document.
result = SpdfCdas::getTimeIntervalChild(domNode)Creates a SpdfTimeInterval object from a child TimeInterval element of the given node from a cdas:DataResult XML document.
result = SpdfCdas::getTimeInterval(timeIntervalElement)Creates a SpdfTimeInterval object from the given TimeInterval element from a cdas:DataResult XML document.
result = SpdfCdas::getJulDate(dateTimeElement)Creates a julday object from the given time element from a cdas:DataResult XML document.
result = SpdfCdas::getThumbnailId(fileElement)Gets the ThumbnailId value from the given cdas:FileDescription element.
result = SpdfCdas::getDataResultText(resultDoc, type)Gets the specified node values from the given cdas:DataResult XML document.
result = SpdfCdas::makeGetRequest(dataview, url [, authenticator=SpdfAuthenticator] [, errorReporter=string])Perform an HTTP GET request to the given URL.
result = SpdfCdas::makePostRequest(dataview, url, xmlRequest [, authenticator=SpdfAuthenticator] [, errorReporter=string])Perform an HTTP POST request to the given URL.
result = SpdfCdas::handleHttpError(request, dataview, username, password [, authenticator=SpdfAuthenticator] [, errorReporter=string])Function to handle HTTP request errors.
result = SpdfCdas::getRequestUrl(url, username, password)Create an IDLnetUrl object from the given URL with any supplied authentication values set.
SpdfCdas__defineDefines the SpdfCdas class.
Routine details
top source SpdfCdas::init
result = SpdfCdas::init( [endpoint=string] [, userAgent=string] [, defaultDataview=string])
Creates an object representing CDAS.
Return value
a reference to a CDAS object.
Keywords
- endpoint in optional type=string default=http://cdaweb.gsfc.nasa.gov/WS/cdasr/1
URL of CDAS web service.
- userAgent in optional type=string default=WsExample
HTTP user-agent value used in communications with CDAS.
- defaultDataview in optional type=string default=sp_phys
default CDAS dataview value to use in subsequent calls when no value is specified.
top source SpdfCdas::cleanup
SpdfCdas::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfCdas::getEndpoint
result = SpdfCdas::getEndpoint()
Gets the current endpoint value.
Return value
current endpoint string value.
top source SpdfCdas::getUserAgent
result = SpdfCdas::getUserAgent()
Gets the current userAgent value.
Return value
current userAgent string value.
top source SpdfCdas::getDefaultDataview
result = SpdfCdas::getDefaultDataview()
Gets the current defaultDataview value.
Return value
current defaultDataview string value.
top source SpdfCdas::getVersion
result = SpdfCdas::getVersion()
Gets the version of this class.
Return value
version of this class.
top source SpdfCdas::getCurrentVersion
result = SpdfCdas::getCurrentVersion()
Gets the most up to date version of this class.
Return value
most up to date version of this class.
top source SpdfCdas::isUpToDate
result = SpdfCdas::isUpToDate()
Compares getversion() and getCurrentversion() to determine if this class is up to date.
Return value
true if getversion() >= getCurrentversion(). Otherwise false.
top source SpdfCdas::getNamedElementsFirstChildValueprivate
result = SpdfCdas::getNamedElementsFirstChildValue(domElement, tagName)
Gets the node's value of the first child of the first item of the specified element of the given DOM document.
Return value
node's string value(s) of the first child of the item(s) of the specified element of the given DOM document. An empty string is returned if the value cannot be found.
Parameters
- domElement in required type=IDLffXMLDOMDocument
DOM element to search
- tagName in required type=string
A scalar string containing the tag name of the desired element.
top source SpdfCdas::getDataviews
result = SpdfCdas::getDataviews( [httpErrorReporter=SpdfHttpErrorReporter])
Gets a description of all the dataviews that are available.
Return value
array of SpdfDataviewDescription objects. If there are no dataviews, an array of length one is returned with the first element being a null object reference.
Keywords
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfCdas::getObservatoryGroups
result = SpdfCdas::getObservatoryGroups( [dataview=string] [, instrumentTypes=strarr] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])
Gets a description of all the observatory groups.
Return value
array of SpdfObservatoryGroupDescription objects. If there are no observatory groups, an array of length one is returned with the first element being a null object reference.
Keywords
- dataview in optional type=string
name of dataview to access.
- instrumentTypes in optional type=strarr
names of instrument-types which restrict the returned observatory groups to only those supporting the specified instrument-types. Valid values are those returned by getInstrumentTypes.
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfCdas::getInstrumentTypes
result = SpdfCdas::getInstrumentTypes( [dataview=string] [, observatoryGroups=strarr] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])
Gets a description of all the instrument types.
Return value
array of SpdfInstrumentTypeDescription objects. If there are no intrument types, an array of length one is returned with the first element being a null object reference.
Keywords
- dataview in optional type=string
name of dataview to access.
- observatoryGroups in optional type=strarr
names of observatory-groups which restrict the returned instrument types to only those supporting the specified observatory-groups. Valid values are those returned by getObservatoryGroups.
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfCdas::getDatasets
result = SpdfCdas::getDatasets( [dataview=string] [, observatoryGroups=strarr] [, instrumentTypes=strarr] [, observatories=strarr] [, instruments=strarr] [, startDate=julday] [, stopDate=julday] [, idPattern=string] [, labelPattern=string] [, notesPattern=string] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])
Gets a description of all the datasets.
Return value
array of SpdfDatasetDescription objects. If there are no datasets, an array of length one is returned with the first element being a null object reference.
Keywords
- dataview in optional type=string
name of dataview to access.
- observatoryGroups in optional type=strarr
names of observatory-groups which restrict the returned datasets to only those supporting the specified observatory-groups. Valid values are those returned by getObservatoryGroups.
- instrumentTypes in optional type=strarr
names of instrument-types which restrict the returned datasets to only those supporting the specified instrument-types. Valid values are those returned by getInstrumentTypes.
- observatories in optional type=strarr
names of observatories which restrict the returned datasets to only those supporting the specified observatories. Valid values are those returned by getObservatories.
- instruments in optional type=strarr
names of instruments which restrict the returned datasets to only those supporting the specified instruments. Valid values are those returned by getInstruments.
- startDate in optional type=julday
value that restricts the returned dataset to only those that contain data after this date.
- stopDate in optional type=julday
value that restricts the returned dataset to only those that contain data before this date.
- idPattern in optional type=string
a java.util.regex compatible regular expression that must match the dataset's identifier value. Omitting this parameter is equivalent to ".*".
- labelPattern in optional type=string
a java.util.regex compatible regular expression that must match the dataset's label text. Omitting this parameter is equivalent to ".*". Embedded matching flag expressions (e.g., (?i) for case insensitive match mode) are supported and likely to be useful in this case.
- notesPattern in optional type=string
a java.util.regex compatible regular expression that must match the dataset's notes text. Omitting this parameter is equivalent to ".*". Embedded matching flag expressions (e.g., (?i) for case insensitive match mode) are supported and likely to be useful in this case.
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfCdas::getInventory
result = SpdfCdas::getInventory(dataset [, dataview=string] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])
Gets a description of a dataset's data inventory.
Return value
an SpdfInventoryDescription or a null reference if no inventory is available.
Parameters
- dataset in type=string
identifies the dataset.
Keywords
- dataview in optional type=string
name of dataview to access.
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfCdas::getVariables
result = SpdfCdas::getVariables(dataset [, dataview=string] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])
Gets a description of a dataset's variables.
Return value
array of SpdfVariableDescription objects. If the dataset has no variables, an array of one null object is returned.
Parameters
- dataset in type=string
identifies the dataset.
Keywords
- dataview in optional type=string
name of dataview to access.
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfCdas::getCdfData
result = SpdfCdas::getCdfData(timeInterval, dataset, variables [, dataview=string] [, cdfVersion=int] [, cdfFormat=string] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])
Gets Common Data Format data from the specified dataset.
Return value
SpdfCdasDataResult object.
Parameters
- timeInterval in type=SpdfTimeInterval
time range of data to get.
- dataset in type=string
identifies the dataset from which data is being requested.
- variables in type=strarr
names of variable's whose data is being requested. If no names are specified, the data of all variables is returned.
Keywords
- dataview in optional type=string
name of dataview to access.
- cdfVersion in optional type=int
is the CDF file version that any created CDF files should be (2 or 3).
- cdfFormat in optional type=string
CDF format of returned data. Valid values are: Binary, CDFML, GzipCDFML, ZipCDFML.
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfCdas::getTextData
result = SpdfCdas::getTextData(timeInterval, dataset, variables [, dataview=string] [, compression=int] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])
Gets a textual representation of data from the specified dataset.
Return value
SpdfCdasDataResult object.
Parameters
- timeInterval in type=SpdfTimeInterval
time range of data to get.
- dataset in type=string
identifies the dataset from which data is being requested.
- variables in type=strarr
names of variable's whose data is being requested. If no names are specified, the data of all variables is returned.
Keywords
- dataview in optional type=string
name of dataview to access.
- compression in optional type=int
the type of compression to use on the result file. Valid values are: Uncompressed, Gzip, Bzip2, Zip.
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfCdas::getGraphData
result = SpdfCdas::getGraphData(timeInterval, datasetRequests [, dataview=string] [, graphOptions=int] [, imageFormat=strarr] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])
Gets a graphical representation of data from the specified dataset.
Return value
SpdfCdasDataResult object.
Parameters
- timeInterval in type=SpdfTimeInterval
time range of data to get.
- datasetRequests in type=objarr of SpdfDatasetRequest
identifies the datasets and variables from which data is being requested.
Keywords
- dataview in optional type=string
name of dataview to access.
- graphOptions in optional type=int
graphing options. Valid values are: CoarseNoiseFilter, DoubleHeightYAxis, CombineGraphs.
- imageFormat in optional type=strarr
Format options for graph. Valid values are: GIF, PNG, PS, PDF.
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfCdas::julDay2Iso8601private
result = SpdfCdas::julDay2Iso8601(value)
Converts the given Julian Day value to an ISO 8601 string representation.
Return value
ISO 8601 string representation of the given value
Parameters
- value in type=julDay
Julian day value to convert.
top source SpdfCdas::getDataprivate
result = SpdfCdas::getData(dataRequest [, dataview=string] [, authenticator=SpdfAuthenticator] [, httpErrorReporter=SpdfHttpErrorReporter])
Make a request to CDAS for the specified data.
Return value
SpdfCdasDataResult object.
Parameters
- dataRequest in type=SpdfCdasDataRequest
specifies the data to get.
Keywords
- dataview in optional type=string
name of dataview to access.
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- httpErrorReporter in optional type=SpdfHttpErrorReporter
used to report an HTTP error.
top source SpdfCdas::getDataResultprivate
result = SpdfCdas::getDataResult(doc)
Creates an SpdfCdasDataResult object from the given cdas:DataResult XML document.
Return value
SpdfCdasDataResult object.
Parameters
- doc in type=IDLffXMLDOMDocument
cdas:DataResult XML document.
top source SpdfCdas::getFileDescriptionsprivate
result = SpdfCdas::getFileDescriptions(doc)
Creates SpdfFileDescription object(s) from the FileDescription elements in the given cdas:DataResult XML document.
Return value
objarr of SpdfFileDescription objects.
Parameters
- doc in type=IDLffXMLDOMDocument
cdas:DataResult XML document.
top source SpdfCdas::getThumbnailDescriptionprivate
result = SpdfCdas::getThumbnailDescription(fileElement)
Creates an SpdfThumbnailDescription object from the FileDescription element in the given cdas:DataResult XML document.
Return value
SpdfThumbnailDescription object.
Parameters
- fileElement in type=IDLffXMLDOMDocument
cdas:FileDescription element from a cdas:DataResult XML document.
top source SpdfCdas::getTimeIntervalChildprivate
result = SpdfCdas::getTimeIntervalChild(domNode)
Creates a SpdfTimeInterval object from a child TimeInterval element of the given node from a cdas:DataResult XML document.
Return value
a reference to a SpdfTimeInterval object.
Parameters
- domNode in type=IDLffXMLDOMNode
node from a cdas:DataResult XML document.
top source SpdfCdas::getTimeIntervalprivate
result = SpdfCdas::getTimeInterval(timeIntervalElement)
Creates a SpdfTimeInterval object from the given TimeInterval element from a cdas:DataResult XML document.
Return value
a reference to a SpdfTimeInterval object.
Parameters
- timeIntervalElement in type=IDLffXMLDOMNode
element from a cdas:DataResult XML document.
top source SpdfCdas::getJulDateprivate
result = SpdfCdas::getJulDate(dateTimeElement)
Creates a julday object from the given time element from a cdas:DataResult XML document.
Return value
julday representation of first child of given dateTimeElement.
Parameters
- dateTimeElement in type=IDLffXMLDOMNodeList
list whose first child is to be converted into a julday
top source SpdfCdas::getThumbnailIdprivate
result = SpdfCdas::getThumbnailId(fileElement)
Gets the ThumbnailId value from the given cdas:FileDescription element.
Return value
ThumbnailId string value.
Parameters
- fileElement in type=IDLffXMLDOMNode
cdas:FileDescription node.
top source SpdfCdas::getDataResultTextprivate
result = SpdfCdas::getDataResultText(resultDoc, type)
Gets the specified node values from the given cdas:DataResult XML document.
Return value
strarr of the specified node values from the given document.
Parameters
- resultDoc in type=IDLffXMLDOMDocument
cdas:DataResult XML document.
- type in type=string
name of elements whose value is to be gotten. This is expected to be one of Message, Warning, Status, or Error.
top source SpdfCdas::makeGetRequestprivate
result = SpdfCdas::makeGetRequest(dataview, url [, authenticator=SpdfAuthenticator] [, errorReporter=string])
Perform an HTTP GET request to the given URL. This method provides functionality similar to doing obj_new('IDLffXMLDOMDocument', filename=url) except that this method will catch an authorization error (401), call the supplied authenticator function, and then retry the request with the authentication credentials obtained from the call to the callers authentication function.
Return value
reference to IDLffXMLDOMDocument representation of HTTP response entity.
Parameters
- dataview in type=string
name of dataview to access.
- url in type=string
URL of GET request to make.
Keywords
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- errorReporter in optional type=string
name of IDL procedure to call if an HTTP error occurs.
top source SpdfCdas::makePostRequestprivate
result = SpdfCdas::makePostRequest(dataview, url, xmlRequest [, authenticator=SpdfAuthenticator] [, errorReporter=string])
Perform an HTTP POST request to the given URL. If an authorization error (401) occurs, the supplied authenticator function is called, and then the request is retried with the authentication credentials obtained from the call to the callers authentication function.
Return value
reference to IDLffXMLDOMDocument representation of HTTP response entity.
Parameters
- dataview in type=string
name of dataview to access.
- url in type=string
URL of GET request to make.
- xmlRequest in type=string
XML entity body to be include in the request.
Keywords
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- errorReporter in optional type=string
name of IDL procedure to call if an HTTP error occurs.
top source SpdfCdas::handleHttpErrorprivate
result = SpdfCdas::handleHttpError(request, dataview, username, password [, authenticator=SpdfAuthenticator] [, errorReporter=string])
Function to handle HTTP request errors. If an authorization error (401) has occurred and an authenticator is provided, the given authenticator is called to obtain authentication credentials. For any other error, if an errorReporter has been provided, it is called.
Return value
a value of 1 if username and password has been set and a value of 0 if not.
Parameters
- request in type=IDLnetURL
HTTP request that caused the error.
- dataview in type=string
name of dataview to access.
- username out type=string
username value obtained by calling the given authenticator.
- password out type=string
password value obtained by calling the given authenticator.
Keywords
- authenticator in optional type=SpdfAuthenticator
authenticator that is used when a dataview requiring authentication is specified.
- errorReporter in optional type=string
name of IDL procedure to call if an HTTP error occurs.
top source SpdfCdas::getRequestUrlprivate
result = SpdfCdas::getRequestUrl(url, username, password)
Create an IDLnetUrl object from the given URL with any supplied authentication values set.
Return value
reference to a IDLnetUrl with any supplied authentication values set.
Parameters
- url in type=string
URL.
- username in type=string
username.
- password in type=string
password.
File attributes
| Modification date: | Thu Mar 13 16:35:32 2014 |
| Lines: | 740 |