This page was created by the IDL library routine mk_html_help2.

Last modified: Thu Aug 6 12:53:14 2020.


Directory Listing of Routines


Routine Descriptions

SPDFAUTHENTICATOR__DEFINE[1]

[Next Routine] [List of Routines]
 This class represents an object that knows how to obtain authentication
 for the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS).  Usually, it will do this by prompting the user for information.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfauthenticator__define.pro)


SPDFAUTHENTICATOR__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfAuthenticator object.

 @returns reference to an SpdfAuthenticator object.

(See external/spdfcdas/spdfauthenticator__define.pro)


SPDFAUTHENTICATOR__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfauthenticator__define.pro)


SPDFAUTHENTICATOR__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Obtains the user's authentication credentials to access the specified
 dataview.

 @param dataview {in} {type=string}
            name of dataview requiring authentication to access.
 @param username {out} {type=string}
            user's name.
 @param password {out} {type=string}
            user's password.
 @returns 1 if username/password has been set.  Otherwise, 0.

(See external/spdfcdas/spdfauthenticator__define.pro)


SPDFAUTHENTICATOR__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the cached credentials for the specified dataview.
 @private

 @param dataview {in} {type=string}
            name of dataview requiring authentication to access.
 @param username {out} {type=string}
            user's name.
 @param password {out} {type=string}
            user's password.
 @returns 1 if username/password has been set.  Otherwise, 0.

(See external/spdfcdas/spdfauthenticator__define.pro)


SPDFAUTHENTICATOR__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Stores the given credentials for the specified dataview in the cache.
 @private

 @param dataview {in} {type=string}
            name of dataview requiring authentication to access.
 @param username {in} {type=string}
            user's name.
 @param password {in} {type=string}
            user's password.
 @returns 1 if credentials  have been cached.  Otherwise, 0.

(See external/spdfcdas/spdfauthenticator__define.pro)


SPDFAUTHENTICATOR__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Adds the given credentials for the specified dataview to the cache.
 @private

 @param dataview {in} {type=string}
            name of dataview requiring authentication to access.
 @param username {in} {type=string}
            user's name.
 @param password {in} {type=string}
            user's password.
 @returns 1 if credentials  have been cached.  Otherwise, 0.

(See external/spdfcdas/spdfauthenticator__define.pro)


SPDFAUTHENTICATOR__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfAuthenticator class.

 @field dataviewCache cache of dataview names.  A dataview's index in
            this array corresponds to its authentication credentials
            in the credentialsCaches.  For example, if 
            dataviewCache[5] = 'dv1', then the authenticaion credentials
            for 'dv1' are credentialsCache[5, 0] and 
            credentialsCache[5, 1].
 @field credentialsCache cache of authentication credentials.

(See external/spdfcdas/spdfauthenticator__define.pro)


SPDFCDASDATAREQUEST__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the DataRequest element from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfcdasdatarequest__define.pro)


SPDFCDASDATAREQUEST__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfCdasDataRequest object.

 @param dataRequestEntity {in} {type=SpdfCdasDataRequestEntity}
            a data request.
 @returns reference to an SpdfCdasDataRequest object.

(See external/spdfcdas/spdfcdasdatarequest__define.pro)


SPDFCDASDATAREQUEST__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfcdasdatarequest__define.pro)


SPDFCDASDATAREQUEST__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the data-request entity.

 @returns reference to dataRequestEntity

(See external/spdfcdas/spdfcdasdatarequest__define.pro)


SPDFCDASDATAREQUEST__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Creates a DataRequest element using the given XML DOM document with the
 values of this object.

 @param doc {in} {type=IDLffXMLDOMDocument}
            document in which to create the DataRequest element.
 @returns a reference to a new IDLffXMLDOMElement representation of
     this object.

(See external/spdfcdas/spdfcdasdatarequest__define.pro)


SPDFCDASDATAREQUEST__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfCdasDataRequest class.

 @field dataRequestEntity data-requent entity.

(See external/spdfcdas/spdfcdasdatarequest__define.pro)


SPDFCDASDATARESULT__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the DataResult element from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis 
 System</a> (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfcdasdataresult__define.pro)


SPDFCDASDATARESULT__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfCdasDataResult object.

 @param fileDescriptions {in} {type=objarr of SpdfFileDescription}
            descriptions of the files comprising this result.
 @keyword messages {in} {optional} {type=strarr} 
            messages related to this result.
 @keyword warnings {in} {optional} {type=strarr} 
            warnings related to this result.
 @keyword statuses {in} {optional} {type=strarr} 
            statuses related to this result.
 @keyword errors {in} {optional} {type=strarr} 
            errors related to this result.
 @returns reference to an SpdfCdasDataResult object.

(See external/spdfcdas/spdfcdasdataresult__define.pro)


SPDFCDASDATARESULT__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfcdasdataresult__define.pro)


SPDFCDASDATARESULT__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the SpdfFileDescriptions.

 @returns a reference to objarr of SpdfFileDescriptions.

(See external/spdfcdas/spdfcdasdataresult__define.pro)


SPDFCDASDATARESULT__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the messages.

 @returns a reference to strarr of messages.

(See external/spdfcdas/spdfcdasdataresult__define.pro)


SPDFCDASDATARESULT__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the warnings.

 @returns a reference to strarr of warnings.

(See external/spdfcdas/spdfcdasdataresult__define.pro)


SPDFCDASDATARESULT__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the statuses.

 @returns a reference to strarr of statuses.

(See external/spdfcdas/spdfcdasdataresult__define.pro)


SPDFCDASDATARESULT__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the errors.

 @returns a reference to strarr of errors.

(See external/spdfcdas/spdfcdasdataresult__define.pro)


SPDFCDASDATARESULT__DEFINE[8]

[Previous Routine] [Next Routine] [List of Routines]
 Prints a textual representation of this object.

(See external/spdfcdas/spdfcdasdataresult__define.pro)


SPDFCDASDATARESULT__DEFINE[9]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfCdasDataResult class.

 @field fileDescriptions descriptions of the files comprising this
            result.
 @field messages messages related to this result.
 @field warnings warnings related to this result.
 @field statuses statuses related to this result.
 @field errors errors related to this result.

(See external/spdfcdas/spdfcdasdataresult__define.pro)


SPDFCDASWSEXAMPLE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This program is an example to demonstrate calling the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis
 System</a>'s 
 <a href="https://cdaweb.gsfc.nasa.gov/WebServices/REST/">
 REST Web Services</a> from an 
 <a href="http://www.harrisgeospatial.com/">Exelis Visual Information 
 Solutions</a>
 (VIS) Interactive Data Language (IDL) program.  It demonstrates the 
 following:
   <ul>
     <li>Getting the available dataviews.</li>
     <li>Getting the available mission groups.</li>
     <li>Getting the available instrument types.</li>
     <li>Getting the available datasets for ACE.</li>
     <li>Getting the variables for the AC_H0_MFI dataset.</li>
     <li>Getting and displaying a portion of an ASCII listing of 
         AC_H0_MFI data.</li>
     <li>Getting a CDF file of AC_H0_MFI data and displaying some of 
         the file's attributes.</li>
     <li>Getting and displaying a graph of AC_H0_MFI data.</li>
     <li>Some basic HTTP error handling.</li>
   </ul>

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfcdaswsexample.pro)


SPDFCDASWSEXAMPLE[2]

[Previous Routine] [Next Routine] [List of Routines]
 This procedure demonstrates how to obtain a local copy of a remote 
 CDF file and display some CDF information about the file's contents.

 @param fileDescription {in} {type=SpdfFileDescription}
            description of a remote CDF file.

(See external/spdfcdas/spdfcdaswsexample.pro)


SPDFCDASWSEXAMPLE[2]

[Previous Routine] [Next Routine] [List of Routines]
 This procedure demonstrates how to obtain a local copy of a remote 
 text file and display a portion of its contents.

 @param fileDescription {in} {type=SpdfFileDescription}
            description of a remote CDF file.

(See external/spdfcdas/spdfcdaswsexample.pro)


SPDFCDASWSEXAMPLE[3]

[Previous Routine] [Next Routine] [List of Routines]
 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.

 @param fileDescription {in} {type=SpdfFileDescription}
            description of a remote file

(See external/spdfcdas/spdfcdaswsexample.pro)


SPDFCDASWSEXAMPLE[4]

[Previous Routine] [Next Routine] [List of Routines]
 This procedure demonstrates how to examine an SpdfFileDescription 
 and then display it based upon it MIME-type.

 @param fileDescription {in} {type=SpdfFileDescription}
            description of a remote file.

(See external/spdfcdas/spdfcdaswsexample.pro)


SPDFCDASWSEXAMPLE[5]

[Previous Routine] [Next Routine] [List of Routines]
 This procedure demonstrates how to examine the result of a data 
 request.

 @param results {in} {type=SpdfCdasDataResult}
            results of a data request.

(See external/spdfcdas/spdfcdaswsexample.pro)


SPDFCDASWSEXAMPLE[6]

[Previous Routine] [Next Routine] [List of Routines]
 This procedure is an example to demonstrate calling the CDAS REST
 Web Services from an IDL program.  It demonstrates the following:
   <ul>
     <li>Getting the available dataviews.</li>
     <li>Getting the available mission groups.</li>
     <li>Getting the available instrument types.</li>
     <li>Getting the available datasets for ACE.</li>
     <li>Getting the variables for the AC_H0_MFI dataset.</li>
     <li>Getting and displaying a portion of an ASCII listing of 
         AC_H0_MFI data.</li>
     <li>Getting a CDF file of AC_H0_MFI data and displaying some of 
         the file's attributes.</li>
     <li>Getting and displaying a graph of AC_H0_MFI data.</li>
     <li>Some basic HTTP error handling.</li>
   </ul>

(See external/spdfcdas/spdfcdaswsexample.pro)


SPDFCDAS__DEFINE[10]

[Previous Routine] [Next Routine] [List of Routines]
 Gets a description of all the dataviews that are available.

 @keyword httpErrorReporter {in} {optional} 
              {type=SpdfHttpErrorReporter}
              used to report an HTTP error.
 @returns 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.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[11]

[Previous Routine] [Next Routine] [List of Routines]
 Gets a description of all the observatory groups.

 @keyword dataview {in} {optional} {type=string}
              name of dataview to access.
 @keyword 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.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword httpErrorReporter {in} {optional} 
              {type=SpdfHttpErrorReporter}
              used to report an HTTP error.
 @returns 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.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[12]

[Previous Routine] [Next Routine] [List of Routines]
 Gets a description of all the instrument types.

 @keyword dataview {in} {optional} {type=string}
              name of dataview to access.
 @keyword 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.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword httpErrorReporter {in} {optional} 
              {type=SpdfHttpErrorReporter}
              used to report an HTTP error.
 @returns 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.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[13]

[Previous Routine] [Next Routine] [List of Routines]
 Gets a description of all the datasets.

 @keyword dataview {in} {optional} {type=string}
              name of dataview to access.
 @keyword 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.
 @keyword 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.
 @keyword 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.
 @keyword 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.
 @keyword startDate {in} {optional} {type=julday}
              value that restricts the returned dataset to only
              those that contain data after this date.
 @keyword stopDate {in} {optional} {type=julday}
              value that restricts the returned dataset to only
              those that contain data before this date.
 @keyword idPattern {in} {optional} {type=string}
              a java.util.regex compatible 
              <a href="https://en.wikipedia.org/wiki/Regex">regular 
              expression</a> that must match the dataset's identifier 
              value.  Omitting this parameter is equivalent to ".*".
 @keyword labelPattern {in} {optional} {type=string}
              a java.util.regex compatible 
              <a href="https://en.wikipedia.org/wiki/Regex">regular 
              expression</a> 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.
 @keyword notesPattern {in} {optional} {type=string}
              a java.util.regex compatible 
              <a href="https://en.wikipedia.org/wiki/Regex">regular 
              expression</a> 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.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword httpErrorReporter {in} {optional} 
              {type=SpdfHttpErrorReporter}
              used to report an HTTP error.
 @returns 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.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[14]

[Previous Routine] [Next Routine] [List of Routines]
 Gets a description of a dataset's data inventory.

 @keyword dataview {in} {optional} {type=string}
              name of dataview to access.
 @param dataset {in} {type=string}
              identifies the dataset.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword httpErrorReporter {in} {optional} 
              {type=SpdfHttpErrorReporter}
              used to report an HTTP error.
 @returns an SpdfInventoryDescription or a null reference if no
              inventory is available.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[15]

[Previous Routine] [Next Routine] [List of Routines]
 Gets a description of a dataset's variables.

 @keyword dataview {in} {optional} {type=string}
              name of dataview to access.
 @param dataset {in} {type=string}
              identifies the dataset.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword httpErrorReporter {in} {optional} 
              {type=SpdfHttpErrorReporter}
              used to report an HTTP error.
 @returns array of SpdfVariableDescription objects.  If the dataset
              has no variables, an array of one null object is 
              returned.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[16]

[Previous Routine] [Next Routine] [List of Routines]
 Gets <a href="https://cdf.gsfc.nasa.gov/">Common Data Format</a>
 data from the specified dataset.

 @keyword dataview {in} {optional} {type=string}
              name of dataview to access.
 @param timeIntervals {in} {type=objarr of SpdfTimeIntervals}
              time intervals of data to get.
 @param dataset {in} {type=string}
              identifies the dataset from which data is being
              requested.
 @param variables {in} {type=strarr}
              names of variable's whose data is being requested.
              If the first (only) name is "ALL-VARIABLES", then the 
              resulting CDF will contain all variables.
 @keyword cdfVersion {in} {optional} {type=int}
              is the CDF file version that any created CDF files 
              should be (2 or 3). 
 @keyword cdfFormat {in} {optional} {type=string}
              CDF format of returned data.  Valid values are:
              Binary, CDFML, GzipCDFML, ZipCDFML.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword httpErrorReporter {in} {optional} 
              {type=SpdfHttpErrorReporter}
              used to report an HTTP error.
 @returns SpdfCdasDataResult object.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[17]

[Previous Routine] [Next Routine] [List of Routines]
 Gets a textual representation of data from the specified dataset.

 @keyword dataview {in} {optional} {type=string}
              name of dataview to access.
 @param timeInterval {in} {type=SpdfTimeInterval}
              time range of data to get.
 @param dataset {in} {type=string}
              identifies the dataset from which data is being
              requested.
 @param 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.
 @keyword compression {in} {optional} {type=int}
              the type of compression to use on the result file.
              Valid values are: Uncompressed, Gzip, Bzip2, Zip.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword httpErrorReporter {in} {optional} 
              {type=SpdfHttpErrorReporter}
              used to report an HTTP error.
 @returns SpdfCdasDataResult object.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[18]

[Previous Routine] [Next Routine] [List of Routines]
 Gets a graphical representation of data from the specified dataset.

 @keyword dataview {in} {optional} {type=string}
              name of dataview to access.
 @param timeInterval {in} {type=SpdfTimeInterval}
              time range of data to get.
 @param datasetRequests {in} {type=objarr of SpdfDatasetRequest}
              identifies the datasets and variables from which data 
              is being requested.
 @keyword graphOptions {in} {optional} {type=int}
              graphing options.  Valid values are:
              CoarseNoiseFilter, DoubleHeightYAxis, CombineGraphs.
 @keyword imageFormat {in} {optional} {type=strarr}
              Format options for graph.  Valid values are:
              GIF, PNG, PS, PDF.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword httpErrorReporter {in} {optional} 
              {type=SpdfHttpErrorReporter}
              used to report an HTTP error.
 @returns SpdfCdasDataResult object.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[19]

[Previous Routine] [Next Routine] [List of Routines]
 Converts the given Julian Day value to an ISO 8601 string 
 representation.

 @private

 @param value {in} {type=julDay}
            Julian day value to convert.
 @returns ISO 8601 string representation of the given value

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class represents the remotely callable interface to 
 <a href="https://www.nasa.gov/">NASA</a>'s
 <a href="https://spdf.gsfc.nasa.gov/">Space Physics Data Facility</a> 
 (SPDF)
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis 
 System</a> (CDAS).

 @copyright Copyright (c) 2010-2018 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.

 @author B. Harris

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[20]

[Previous Routine] [Next Routine] [List of Routines]
 Make a request to CDAS for the specified data.

 @private

 @keyword dataview {in} {optional} {type=string}
              name of dataview to access.
 @param dataRequest {in} {type=SpdfCdasDataRequest}
              specifies the data to get.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword httpErrorReporter {in} {optional} 
              {type=SpdfHttpErrorReporter}
              used to report an HTTP error.
 @returns SpdfCdasDataResult object.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[21]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfCdasDataResult object from the given cdas:DataResult
 XML document.

 @private

 @param doc {in} {type=IDLffXMLDOMDocument}
              cdas:DataResult XML document.
 @returns SpdfCdasDataResult object.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[22]

[Previous Routine] [Next Routine] [List of Routines]
 Creates SpdfFileDescription object(s) from the FileDescription
 elements in the given cdas:DataResult XML document.

 @private

 @param doc {in} {type=IDLffXMLDOMDocument}
              cdas:DataResult XML document.
 @returns objarr of SpdfFileDescription objects.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[23]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfThumbnailDescription object from the FileDescription
 element in the given cdas:DataResult XML document.

 @private

 @param fileElement {in} {type=IDLffXMLDOMDocument}
              cdas:FileDescription element from a cdas:DataResult XML 
              document.
 @returns SpdfThumbnailDescription object.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[24]

[Previous Routine] [Next Routine] [List of Routines]
 Creates a SpdfTimeInterval object from a child TimeInterval element
 of the given node from a cdas:DataResult XML document.

 @private

 @param domNode {in} {type=IDLffXMLDOMNode}
              node from a cdas:DataResult XML document.
 @returns a reference to a SpdfTimeInterval object.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[25]

[Previous Routine] [Next Routine] [List of Routines]
 Creates a SpdfTimeInterval object from the given TimeInterval element
 from a cdas:DataResult XML document.

 @private

 @param timeIntervalElement {in} {type=IDLffXMLDOMNode}
              element from a cdas:DataResult XML document.
 @returns a reference to a SpdfTimeInterval object.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[26]

[Previous Routine] [Next Routine] [List of Routines]
 Creates a julday object from the given time element from a 
 cdas:DataResult XML document.

 @private

 @param dateTimeElement {in} {type=IDLffXMLDOMNodeList}
              list whose first child is to be converted into a julday
 @returns julday representation of first child of given 
              dateTimeElement.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[27]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the ThumbnailId value from the given cdas:FileDescription 
 element.

 @private

 @param fileElement {in} {type=IDLffXMLDOMNode}
              cdas:FileDescription node.
 @returns ThumbnailId string value.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[28]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the specified node values from the given cdas:DataResult XML 
 document.

 @private

 @param resultDoc {in} {type=IDLffXMLDOMDocument}
            cdas:DataResult XML document.
 @param 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.
 @returns strarr of the specified node values from the given document.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[29]

[Previous Routine] [Next Routine] [List of Routines]
 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.

 @private

 @param dataview {in} {type=string}
            name of dataview to access.
 @param url {in} {type=string}
            URL of GET request to make.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword errorReporter {in} {optional} {type=string}
              name of IDL procedure to call if an HTTP error occurs.
 @returns reference to IDLffXMLDOMDocument representation of HTTP
     response entity.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an object representing CDAS.  
 
 If access to the Internet is through an HTTP proxy, the caller 
 should ensure that the HTTP_PROXY environment is correctly set 
 before this method is called.  The HTTP_PROXY value should be of 
 the form 
 http://username:password@hostname:port/.

 @keyword endpoint {in} {optional} {type=string}
              {default='https://cdaweb.gsfc.nasa.gov/WS/cdasr/1'}
              URL of CDAS web service.
 @keyword userAgent {in} {optional} {type=string} {default=WsExample}
              HTTP user-agent value used in communications with CDAS.
 @keyword defaultDataview {in} {optional} {type=string} 
              {default=sp_phys}
              default CDAS dataview value to use in subsequent calls
              when no value is specified.
 @keyword sslVerifyPeer {in} {optional} {type=int} {default=1}
              Specifies whether the authenticity of the peer's SSL
              certificate should be verified.  When 0, the connection 
              succeeds regardless of what the peer SSL certificate 
              contains.
 @returns a reference to a CDAS object.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[30]

[Previous Routine] [Next Routine] [List of Routines]
 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.

 @private

 @param dataview {in} {type=string}
            name of dataview to access.
 @param url {in} {type=string}
            URL of GET request to make.
 @param xmlRequest {in} {type=string}
            XML entity body to be include in the request.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword errorReporter {in} {optional} {type=string}
              name of IDL procedure to call if an HTTP error occurs.
 @returns reference to IDLffXMLDOMDocument representation of HTTP
     response entity.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[31]

[Previous Routine] [Next Routine] [List of Routines]
 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.

 @private

 @param request {in} {type=IDLnetURL}
            HTTP request that caused the error.
 @param dataview {in} {type=string}
            name of dataview to access.
 @param username {out} {type=string}
            username value obtained by calling the given authenticator.
 @param password {out} {type=string}
            password value obtained by calling the given authenticator.
 @keyword authenticator {in} {optional} {type=SpdfAuthenticator}
              authenticator that is used when a dataview requiring
              authentication is specified.
 @keyword errorReporter {in} {optional} {type=string}
              name of IDL procedure to call if an HTTP error occurs.
 @returns a value of 1 if username and password has been set and a 
     value of 0 if not. 

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[32]

[Previous Routine] [Next Routine] [List of Routines]
 Create an IDLnetURL object from the given URL with any supplied
 authentication values set.

 @private

 @param url {in} {type=string}
            URL.
 @param username {in} {type=string}
            username.
 @param password {in} {type=string}
            password.
 @returns reference to a IDLnetURL with any supplied authentication
     values set.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[33]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfCdas class.

 @field endpoint URL of CDAS web service.
 @field defaultDataview CDAS dataview to access when the dataview is
               not specified.
 @field userAgent HTTP 
            <a href="https://tools.ietf.org/html/rfc2616#section-14.43">
               user-agent value</a> to use in communications with CDAS.
 @field version identifies the version of this class.
 @field currentVersionUrl URL to the file identifying the most up to 
            date version of this class.
 @field proxy_authentication IDLnetURL PROXY_AUTHENTICATION property
            value.
 @field proxy_hostname IDLnetURL PROXY_HOSTNAME property value.
 @field proxy_password IDLnetURL PROXY_PASSWORD property value.
 @field proxy_port IDLnetURL PROXY_PORT property value.
 @field proxy_username IDLnetURL PROXY_USERNAME property value.
 @field ssl_verify_peer IDLnetURL SSL_VERIFY_PEER property value.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the current endpoint value.

 @returns current endpoint string value.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the current userAgent value.

 @returns current userAgent string value.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the current defaultDataview value.

 @returns current defaultDataview string value.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the version of this class.

 @returns version of this class.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the most up to date version of this class.

 @returns most up to date version of this class.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[8]

[Previous Routine] [Next Routine] [List of Routines]
 Compares getVersion() and getCurrentVersion() to determine if this
 class is up to date.

 @returns true if getVersion() >= getCurrentVersion().  Otherwise 
     false.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAS__DEFINE[9]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the node's value of the first child of the first item of the
 specified element of the given DOM document.

 @private

 @param domElement {in} {required} {type=IDLffXMLDOMDocument}
                DOM element to search
 @param tagName {in} {required} {type=string}
                A scalar string containing the tag name of the desired
                element.
 @returns 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.

(See external/spdfcdas/spdfcdas__define.pro)


SPDFCDAWEBCHOOSERAUTHENTICATOR__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is the SpdfCdawebChooser's specialization of an
 SpdfCdawebChooserAuthenticator.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfcdawebchooserauthenticator__define.pro)


SPDFCDAWEBCHOOSERAUTHENTICATOR__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfCdawebChooserAuthenticator object.

 @param groupLeader {in} {type=long}
            widget ID of "group leader" for this authentication widget.
 @returns reference to an SpdfCdawebChooserAuthenticator object.

(See external/spdfcdas/spdfcdawebchooserauthenticator__define.pro)


SPDFCDAWEBCHOOSERAUTHENTICATOR__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfcdawebchooserauthenticator__define.pro)


SPDFCDAWEBCHOOSERAUTHENTICATOR__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Obtains the user's authentication credentials to access the specified
 dataview.

 @param dataview {in} {type=string}
            name of dataview requiring authentication to access.
 @param username {out} {type=string}
            user's name.
 @param password {out} {type=string}
            user's password.
 @returns 1 if username/password has been set.  Otherwise, 0.

(See external/spdfcdas/spdfcdawebchooserauthenticator__define.pro)


SPDFCDAWEBCHOOSERAUTHENTICATOR__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfCdawebChooserAuthenticator class.

 @field tlb widet ID of top-level base widet.

(See external/spdfcdas/spdfcdawebchooserauthenticator__define.pro)


SPDFCDAWEBCHOOSER[10]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to a "save data" button event.

 @param event {in} {type=widget event}
            event triggering the execution of this function.
 @returns 0

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[11]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to an event that initiates a search for datasets that
 satisfies the users previous selections.

 @param event {in} {type=widget_button}
            event triggering the execution of this procedure.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[12]

[Previous Routine] [Next Routine] [List of Routines]
 Determines if the given string is a valid date/time value.

 @param value {in} {type=string}
            value to be tested.
 @returns true if the given string is a valid date/time value.
             Otherwise false.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[13]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the dataset and variable selection values.

 @param datasetTree {in} {type=int}
            id of dataset tree widget.
 @param selectedDatasetId {out} {type=string}
            id of selected dataset.
 @param selectedVarNames {out} {type=strarr}
            names of selected variables.
 @returns 1 if a valid selections was made.  0 if the selection
              was invalid.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[14]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the specified time interval.

 @param startTimeWidget {in} {type=int}
            id of start time widget.
 @param stopTimeWidget {in} {type=int}
            id of stop time widget.
 @returns specifed time interval or null object reference if an
              invalid value was specified.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[15]

[Previous Routine] [Next Routine] [List of Routines]
 Creates IDL statements to read the specified data into an IDL 
 environment.  

 @param state {in} {type=struct}
            widget program's state.
 @param timeInterval {in} {type=SpdfTimeInterval}
            time range of data to get.  If this is not a valid
            object reference, then the generated IDL statement
            contains the variable names t_init and t_final instead
            of actual time values.
 @param datasetId {in} {type=string}
            dataset identifier.
 @param varNames {in} {type=strarr}
            names of variables containing the desired data.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[16]

[Previous Routine] [Next Routine] [List of Routines]
 Executes the the operation to retrieve the specified data into this
 IDL environment.

 @param state {in} {type=struct}
            widget program's state.
 @param timeInterval {in} {type=SpdfTimeInterval}
            time range of data to get.
 @param datasetId {in} {type=string}
            dataset identifier.
 @param varNames {in} {type=strarr}
            names of variables containing the desired data.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[17]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to an event requesting the retrieval of the data
 specified by the users previous selections.

 @param event {in} {type=widget_button}
            event triggering the execution of this procedure.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[18]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to an event requesting the IDL code to retrieve the data
 specified by the users previous selections.

 @param event {in} {type=widget_button}
            event triggering the execution of this procedure.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[19]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to an event requesting that data be read from a local
 file.

 @param event {in} {type=widget_button}
            event triggering the execution of this procedure.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[1]

[Previous Routine] [Next Routine] [List of Routines]
 This program provides a GUI for choosing datasets from 
 <a href="https://cdaweb.gsfc.nasa.gov/">CDAWeb</a>.
 
 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[20]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to an event requesting the CDAWlib's plot of the retrieved
 data specified by the users previous selections.

 @param event {in} {type=widget_button}
            event triggering the execution of this procedure.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[21]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to an event requesting the CDAWlib's listing of the retrieved
 data specified by the users previous selections.

 @param event {in} {type=widget_button}
            event triggering the execution of this procedure.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[22]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to an event that initiates a termination of this program.

 @param event {in} {type=widget_button}
            event triggering the execution of this procedure.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[23]

[Previous Routine] [Next Routine] [List of Routines]
 Display information about this software.

 @param event {in} {type=widget_button}
            event triggering the execution of this procedure.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[24]

[Previous Routine] [Next Routine] [List of Routines]
 Gets all dataview descriptions.

 @private

 @param cdas {in} {required} {type=SpdfCdas}
            the Coordinated Data Analysis System.
 @returns objarr containing SpdfDataviewDescription objects for all
              cdaweb dataviews.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[25]

[Previous Routine] [Next Routine] [List of Routines]
 Provides a GUI for choosing and retrieving data from 
 <a href="https://cdaweb.gsfc.nasa.gov/">CDAWeb</a>.
 
 If access to the Internet is through an HTTP proxy, the caller 
 should ensure that the HTTP_PROXY environment is correctly set 
 before this procedure is called.  The HTTP_PROXY value should be of 
 the form 
 http://username:password@hostname:port/.

 @keyword endpoint {in} {optional} {type=string}
              {default=SpdfCdas->getDefaultEndpoint()}
              URL of CDAS web service.
 @keyword GROUP_LEADER {in} {optional} {type=int}
              The widget ID of the group leader for this window.  If
              no value is provided, the resulting window will not
              belong to a group and will be non-blocking.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[2]

[Previous Routine] [Next Routine] [List of Routines]
 Selects a dataview.

 @param tlb {in} {type=int}
            widget id of top level base.
 @param dvList {in} {type=int}
            widget id of dataview list widget.
 @param dvIndex {in} {type=int}
            index of dataview to select

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[2]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to a "dataview selected" event.

 @param event {in} {type=widget event}
            widget_list event.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[3]

[Previous Routine] [Next Routine] [List of Routines]
 Finds the specified dataset description within the given array of
 descriptions.

 @private

 @param descriptions {in} {type=SpdfDatasetDescription}
            Array of descriptions to search (for example, 
            state.datasets).
 @param id {in} {type=string}
            Dataset identifier.
 @returns Dataset description from descriptions with the specified id
              or a NULL object reference if the description was not
              found.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[4]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to a dataset tree event.

 @param event {in} {type=widget event}
            event triggering the execution of this procedure

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[5]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to a request to view a dataset's notes.

 @param event {in} {type=widget event}
            event triggering the execution of this procedure

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[6]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to an inventory window close event.

 @param event {in} {type=widget_button}
            event triggering the execution of this procedure.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[7]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to a request to view a dataset's inventory.

 @param event {in} {type=widget event}
            event triggering the execution of this procedure

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[8]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to a request to set a default time value.

 @param event {in} {type=widget event}
            event triggering the execution of this procedure

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDAWEBCHOOSER[9]

[Previous Routine] [Next Routine] [List of Routines]
 Responds to an event by doing nothing (ignoring it).

 @param event {in} {type=widget event}
            event triggering the execution of this procedure.

(See external/spdfcdas/spdfcdawebchooser.pro)


SPDFCDFREQUEST__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the CdfRequest element from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfcdfrequest__define.pro)


SPDFCDFREQUEST__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfCdfRequest object.

 @param timeIntervals {in} {type=objarr of SpdfTimeIntervals}
            time intervals that the requested CDF is to contain data 
            for.
 @param datasetRequest {in} {type=SpdfDatasetRequest}
            specifies the dataset information.  Note that if the first
            (only) variableName is "ALL-VARIABLES", the resulting CDF
            will contain all variables.
 @keyword cdfVersion {in} {type=int} {default=3}
            version of CDF file.
 @keyword cdfFormat {in} {type=string} {default=Binary}
            format of CDF file.
 @returns reference to an SpdfCdfRequest object.

(See external/spdfcdas/spdfcdfrequest__define.pro)


SPDFCDFREQUEST__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfcdfrequest__define.pro)


SPDFCDFREQUEST__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the time intervals.

 @returns reference to objarr of time intervals.

(See external/spdfcdas/spdfcdfrequest__define.pro)


SPDFCDFREQUEST__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the dataset request.

 @returns reference to dataset request.

(See external/spdfcdas/spdfcdfrequest__define.pro)


SPDFCDFREQUEST__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the CDF version.

 @returns CDF version.

(See external/spdfcdas/spdfcdfrequest__define.pro)


SPDFCDFREQUEST__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the CDF format.

 @returns CDF format.

(See external/spdfcdas/spdfcdfrequest__define.pro)


SPDFCDFREQUEST__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Creates a CdfRequest element using the given XML DOM document with the
 values of this object.

 @param doc {in} {type=IDLffXMLDOMDocument}
            document in which to create the CdfRequest element.
 @returns a reference to a new IDLffXMLDOMElement representation of
     this object.

(See external/spdfcdas/spdfcdfrequest__define.pro)


SPDFCDFREQUEST__DEFINE[8]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfCdfRequest class.

 @field timeIntervals time intervals of this request.
 @field datasetRequest identifies the dataset for this request.
 @field cdfFormat indicates the desired format of the CDF file.
 @field cdfVersion indicates the desired version of the CDF file.

(See external/spdfcdas/spdfcdfrequest__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[10]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the Principal Investigator value.

 @returns Principal Investigator value.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[11]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the Principal Investigator's affilation value.

 @returns Principal Investigator's affilation value.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[12]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the notes value.

 @returns notes value.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[13]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the links.

 @returns objarr of links.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[14]

[Previous Routine] [Next Routine] [List of Routines]
 Prints a textual representation of this object.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[15]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfDatasetDescription class.

 @field id dataset identifier.
 @field observatories observatories that contributed data to this
            dataset.
 @field instruments intruments that contributed data to this 
            dataset.
 @field observatoryGroups observatoryGroups that contributed data 
            to this dataset.
 @field instrumentTypes instrumentTypes that contributed data 
            to this dataset.
 @field label dataset label.
 @field timeInterval time interval of this dataset.
 @field piName name of Principal Investigator.
 @field piAffiliation affiliation of PI.
 @field notes notes about this dataset.
 @field datasetLinks links to information about this dataset.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the DatasetDescription element
 from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfDatasetDescription object.

 @param id {in} {type=string}
            dataset identifier.
 @param observatories {in} {type=strarr}
            observatories that contributed data to this dataset.
 @param instruments {in} {type=strarr}
            intruments that contributed data to this dataset.
 @param observatoryGroups {in} {type=strarr}
            observatoryGroups that contributed data to this dataset.
 @param instrumentTypes {in} {type=strarr}
            instrumentTypes that contributed data to this dataset.
 @param label {in} {type=string}
            dataset label.
 @param timeInterval {in} {type=SpdfTimeInterval}
            time interval of this dataset.
 @param piName {in} {type=string}
            name of Principal Investigator.
 @param piAffiliation {in} {type=string}
            affiliation of PI.
 @param notes {in} {type=string}
            notes about this dataset.
 @param datasetLinks {in} {type=objarr of SpdfDatasetLink}
            links to information about this dataset.
 @returns reference to an SpdfDatasetDescription object.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the id value.

 @returns id value.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the observatories.

 @returns strarr of observatories.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the instruments.

 @returns strarr of instruments.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the observatoryGroups.

 @returns strarr of observatoryGroups.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the instrumentTypes.

 @returns strarr of instrumentTypes.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[8]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the label value.

 @returns label value.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETDESCRIPTION__DEFINE[9]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the TimeInterval value.

 @returns TimeInterval value.

(See external/spdfcdas/spdfdatasetdescription__define.pro)


SPDFDATASETLINK__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the DatasetLink element from 
 the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfdatasetlink__define.pro)


SPDFDATASETLINK__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfDatasetLink object.

 @param title {in} {type=string}
            link title value.
 @param text {in} {type=string}
            link text value.
 @param url {in} {type=string}
            link URL value.
 @returns reference to an SpdfDatasetLink object.

(See external/spdfcdas/spdfdatasetlink__define.pro)


SPDFDATASETLINK__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfdatasetlink__define.pro)


SPDFDATASETLINK__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the title value.

 @returns title value.

(See external/spdfcdas/spdfdatasetlink__define.pro)


SPDFDATASETLINK__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the text value.

 @returns text value.

(See external/spdfcdas/spdfdatasetlink__define.pro)


SPDFDATASETLINK__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the URL value.

 @returns URL value.

(See external/spdfcdas/spdfdatasetlink__define.pro)


SPDFDATASETLINK__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Prints a textual representation of this object.

(See external/spdfcdas/spdfdatasetlink__define.pro)


SPDFDATASETLINK__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfDatasetLink class.

 @field title link title value.
 @field text link text value.
 @field url link URL value.

(See external/spdfcdas/spdfdatasetlink__define.pro)


SPDFDATASETREQUEST__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the DatasetRequest element 
 from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfdatasetrequest__define.pro)


SPDFDATASETREQUEST__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfDatasetRequest object.

 @param datasetId {in} {type=string}
            dataset identifier.
 @param variableNames {in} {type=strarr}
            names of variables.
 @returns reference to an SpdfDatasetRequest object.

(See external/spdfcdas/spdfdatasetrequest__define.pro)


SPDFDATASETREQUEST__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfdatasetrequest__define.pro)


SPDFDATASETREQUEST__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the dataset identifier.

 @returns dataset identifier.

(See external/spdfcdas/spdfdatasetrequest__define.pro)


SPDFDATASETREQUEST__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Get the variable names.

 @returns variable names.

(See external/spdfcdas/spdfdatasetrequest__define.pro)


SPDFDATASETREQUEST__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Creates a DataRequest element using the given XML DOM document with 
 the values of this object.

 @param doc {in} {type=IDLffXMLDOMDocument}
            document in which to create the DataRequest element.
 @returns a reference to a new IDLffXMLDOMElement representation of
     this object.

(See external/spdfcdas/spdfdatasetrequest__define.pro)


SPDFDATASETREQUEST__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfDatasetRequest class.

 @field datasetId dataset identifier.
 @field variableNames variable names.

(See external/spdfcdas/spdfdatasetrequest__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[10]

[Previous Routine] [Next Routine] [List of Routines]
 Prints a textual representation of this object.

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[11]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfDataviewDescription class.

 @field id identifier.
 @field endpointAddress access URL.
 @field title title.
 @field subtitle sub-title.
 @field overview overview description.
 @field underConstruction under-construction flag.
 @field noticeUrl URL of notice.
 @field publicAccess public-access flag.

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the DataviewDescription 
 element from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfDataviewDescription object.

 @param id {in} {type=string}
            dataview identifier.
 @param endpointAddress {in} {type=string}
            URL to access this dataview.
 @param title {in} {type=string}
            title of dataview.
 @param subtitle {in} {type=string}
            sub-title of dataview.
 @param overview {in} {type=string}
            overview description of this dataview.
 @param underConstruction {in} {type=byte}
            indicates whether the dataview is in the process of being
            constructed.
 @param noticeUrl {in} {type=string}
            URL of notice concerning this dataview.
            constructed.
 @param publicAccess {in} {type=byte}
            indicates whether the dataview requires authentication
            to access.
 @returns reference to an SpdfDataviewDescription object.

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the identifier.

 @returns identifier value.

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the endpointAddress.

 @returns endpointAddress value.

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the title.

 @returns title value.

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the sub-title.

 @returns sub-title value.

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the overview description.

 @returns overview value

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the underConstruction flag.

 @returns underConstruction value.

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[8]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the notice URL.

 @returns notice URL value.

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFDATAVIEWDESCRIPTION__DEFINE[9]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the public-access flag.

 @returns public-access value.

(See external/spdfcdas/spdfdataviewdescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[10]

[Previous Routine] [Next Routine] [List of Routines]
 Prints a textual representation of this object.

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[11]

[Previous Routine] [Next Routine] [List of Routines]
 Retrieves this file from a remote HTTP or FTP server and writes 
 it to disk, a memory buffer, or an array of strings. The returned 
 data is written to disk in the location specified by the FILENAME 
 keyword. If the filename is not specified, the local name will be
 the same as this file's name in the current working directory.
 
 @keyword buffer {in} {optional} {type=boolean} {default=false}
            if this keyword is set, the return value is a buffer 
            and the FILENAME keyword is ignored.
 @keyword filename {in} {optional} {type=string} 
            set this keyword equal to a string that holds the file 
            name and path where the retrieved file is locally stored.
            If FILENAME specifies a full path, the file is stored in 
            the specified path.  If FILENAME specifies a relative 
            path, the path is relative to IDL's current working 
            directory.  If FILENAME is not present the file is
            stored in the current working directory under the name 
            the basename of filename.  If FILENAME is the same 
            between calls, the last file received is overwritten.
 @keyword string_array {in} {optional} {type=boolean} {default=false}
            set this keyword to treat the return value as an array 
            of strings. If this keyword is set, the FILENAME and 
            BUFFER keywords are ignored.
 @keyword callback_function {in} {optional} {type=string}
            this keyword value is the name of the IDL function that
            is to be called during this retrieval operation.  The 
            callbacks provide feedback to the user about the ongoing 
            operation, as well as provide a method to cancel an 
            ongoing operation. If this keyword is not set, no
            callback to the caller is made.  For information on 
            creating a callback function, see "Using Callbacks with 
            the IDLnetURL Object" in the IDL documentation.
 @keyword callback_data {in} {optional} {type=reference}
            this keyword value contains data that is passed to the 
            caller when a callback is made. The data contained in 
            this variable is defined and set by the caller. The 
            variable is passed, unmodified, directly to the caller 
            as a parameter in the callback function. If this keyword
            is not set, the corresponding callback parameter's value
            is undefined.
 @keyword sslVerifyPeer {in} {optional} {type=int} {default=1}
            Specifies whether the authenticity of the peer's SSL
            certificate should be verified.  When 0, the connection
            succeeds regardless of what the peer SSL certificate
            contains.
 @returns one of the following: A string containing the full path 
            of the file retrieved from the remote HTTP or FTP server,
            A byte vector, if the BUFFER keyword is set, An array of 
            strings, if the STRING_ARRAY keyword is set, A null 
            string, if no data were returned by the method.

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[12]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfFileDescription class.

 @field name name of file.
 @field mimeType MIME-type of file.
 @field timeInterval time interval of data in file.
 @field length file's length (in bytes).
 @field lastModified data of last modification (julday).
 @field thumbnailDescription description of thumbnail images when
            this file contains thumbnail images.  Otherwise, NULL.
 @field thumbnailId thumbnail description identifier when this file
            contains thumbnail images.  Otherwise, ''.
 @field proxy_authentication IDLnetURL PROXY_AUTHENTICATION property
            value.
 @field proxy_hostname IDLnetURL PROXY_HOSTNAME property value.
 @field proxy_password IDLnetURL PROXY_PASSWORD property value.
 @field proxy_port IDLnetURL PROXY_PORT property value.
 @field proxy_username IDLnetURL PROXY_USERNAME property value.

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the FileDescription element 
 from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis 
 System</a> (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfFileDescription object.

 If access to the Internet is through an HTTP proxy, the caller 
 should ensure that the HTTP_PROXY environment is correctly set 
 before this method is called.  The HTTP_PROXY value should be of 
 the form 
 http://username:password@hostname:port/.

 @param name {in} {type=string}
            name of file.
 @param mimeType {in} {type=string}
            (Multipurpose Internet Mail Extensions) MIME-type of file.
 @param timeInterval {in} {type=SpdfTimeInterval}
            time interval of the data in this file.
 @param length {in} {type=long64}
            length (in bytes) of file.
 @param lastModified {in} {type=double}
            date file was last modified (julday value).
 @keyword thumbnailDescription {in} {optional}
            {type=SpdfThumbnailDescription}
            if file contains thumbnail images, then this describes
            them.
 @keyword thumbnailId {in} {optional} {type=SpdfThumbnailId}
            if file contains thumbnail images, then this contains
            an opaque value that the server needs to provide 
            full-sized versions of the images.
 @returns reference to an SpdfFileDescription object.

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the file's name.

 @returns filename value.

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the MIME-type of file.

 @returns MIME-type value.

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Gets time interval of data in file.

 @returns time interval of data.

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the file's length (in bytes).

 @returns file's length (bytes).

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Gets date the file was last modified.

 @returns date of last modification (julday value).

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[8]

[Previous Routine] [Next Routine] [List of Routines]
 Gets thumbnail description.

 @returns thumbnail description or NULL object reference if this file
     is not thumbnail images.

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFFILEDESCRIPTION__DEFINE[9]

[Previous Routine] [Next Routine] [List of Routines]
 Gets thumbnail identifier.

 @returns thumbnail identifier or an empty string if this file
     is not thumbnail images.

(See external/spdfcdas/spdffiledescription__define.pro)


SPDFGETDATA[1]

[Previous Routine] [Next Routine] [List of Routines]
 This file contains a procedure-oriented wrapper that integrates
 functionality from the SpdfCdas class (IDL client interface to
 <a href="https://cdaweb.gsfc.nasa.gov/WebServices">
 Coordinated Data Analysis System Web Services</a> (CDAS WSs))
 and the 
 <a href="https://spdf.gsfc.nasa.gov/CDAWlib.html">CDAWlib</a>
 library.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfgetdata.pro)


SPDFGETDATA[2]

[Previous Routine] [Next Routine] [List of Routines]
 This function is an example of a callback_function for the
 spdfGetData function.

 @param statusInfo {in} {type=strarr}
 @param progressInfo {in} {type=lon64arr}
 @param callbackData {in} {type=reference}
 @returns a continue flag.  A return value of zero indicates that
     the operation should be cancelled.  A return value of one 
     indicates that the operation should continue.

(See external/spdfcdas/spdfgetdata.pro)


SPDFGETDATA[2]

[Previous Routine] [Next Routine] [List of Routines]
 This function gets data from <a href="https://www.nasa.gov/">NASA</a>'s
 <a href="https://spdf.gsfc.nasa.gov/">Space Physics Data Facility</a>
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis 
 System</a>.

 @param dataset {in} {type=string}
            name of dataset to get data from.
 @param variables {in} {out} {type=strarr}
            On entry, names of variables whose values are to be gotten.
            If the first (only) name is "ALL-VARIABLES", then the 
            resulting CDF will contain all variables.
            On exit, names of variables actually read (may be more 
            than requested).
 @param timeSpans {in} {type=strarr(n, 2)}
            ISO 8601 format strings of the start and stop times of the
            data to get.
 @keyword dataview {in} {optional} {type=string} {default='sp_phys'}
            name of dataview containing the dataset.
 @keyword endpoint {in} {optional} {type=string}
              {default='https://cdaweb.gsfc.nasa.gov/WS/cdasr/1'}
              URL of CDAS web service.
 @keyword keepfiles {in} {optional} {type=boolean} {default=false}
            The KEEPFILES keyword causes SpdfGetData to retain the
            downloaded data files.  Normally these files are deleted
            after the data is read into the IDL environment.
 @keyword quiet {in} {optional} {type=boolean} {default=false}
            SpdfGetData normally prints an error message if no data is
            found.  If QUIET is set, no error messages is printed.
 @keyword verbose {in} {optional} {type=boolean} {default=false}
            The VERBOSE keyword causes SpdfGetData to print additional
            status, debugging, and usage information.
 @keyword callback_function {in} {optional} {type=string}
            this keyword value is the name of the IDL function that
            is to be called during this retrieval operation.  The 
            callbacks provide feedback to the user about the ongoing 
            operation, as well as provide a method to cancel an 
            ongoing operation. If this keyword is not set, no
            callback to the caller is made.  For information on 
            creating a callback function, see "Using Callbacks with 
            the IDLnetURL Object" in the IDL documentation.
 @keyword callback_data {in} {optional} {type=reference}
            this keyword value contains data that is passed to the 
            caller when a callback is made. The data contained in 
            this variable is defined and set by the caller. The 
            variable is passed, unmodified, directly to the caller 
            as a parameter in the callback function. If this keyword
            is not set, the corresponding callback parameter's value
            is undefined.
 @keyword sslVerifyPeer {in} {optional} {type=int} {default=1}
            Specifies whether the authenticity of the peer's SSL
            certificate should be verified.  When 0, the connection 
            succeeds regardless of what the peer SSL certificate 
            contains.
 @returns structure containing requested data.  Note that a few 
     datasets in CDAS contain variables with names that cannot
     be used as tag names an IDL structure.  In those cases, the
     tag name in this structure will be a modification of the
     actual CDF variable name.  For example, if you requested the
     'H+' variable from the 'FA_K0_TMS' dataset, the 'H+' values
     will be returned in a structure under the tag name 'H$'.
 @examples
   <pre>
     d = spdfgetdata('AC_K2_MFI', ['Magnitude', 'BGSEc'], $
           ['2013-01-01T00:00:00.000Z', '2013-01-03T00:00:00.000Z'], $
           /VERBOSE)

     The Epoch values are returned in d.epoch.dat
     The Magnitude values are in d.magnitude.dat
     The BGSEc values are in d.bgsec.dat
 
    To see further info. about each variable type 
        help, /struct, d."variablename"
    To make a plot with the CDAWlib s/w type 
        s = plotmaster(d, /AUTO, /CDAWEB, /GIF, /SMOOTH, /SLOW)
   </pre>

(See external/spdfcdas/spdfgetdata.pro)


SPDFGETDEFAULTSSLVERIFYPEER

[Previous Routine] [Next Routine] [List of Routines]
 Gets the default value for the IDLnetURL SSL_VERIFY_PEER property
 based upon the current version of IDL.

 @returns 0 if current version of IDL cannot verify new SSL certificates.
     Otherwise, 1.

(See external/spdfcdas/spdfgetdefaultsslverifypeer.pro)


SPDFGRAPHREQUEST__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the GraphRequest element from 
 the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfgraphrequest__define.pro)


SPDFGRAPHREQUEST__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfGraphRequest object.

 @param timeInterval {in} {type=SpdfTimeInterval}
            time interval that the requested graph is to contain data
            for.
 @param datasetRequests {in} {type=objarr of SpdfDatasetRequests}
            specifies the dataset information.
 @keyword graphOptions {in} {type=int} {default=0}
            graph option bit-mask value.
 @keyword imageFormats {in} {type=strarr} {default=PNG}
            format of graph file.
 @returns reference to an SpdfGraphRequest object.

(See external/spdfcdas/spdfgraphrequest__define.pro)


SPDFGRAPHREQUEST__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfgraphrequest__define.pro)


SPDFGRAPHREQUEST__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the time interval of this request.

 @returns time interval of this request.

(See external/spdfcdas/spdfgraphrequest__define.pro)


SPDFGRAPHREQUEST__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the dataset information of this request.

 @returns reference to objarr of SpdfDatasetRequest's.

(See external/spdfcdas/spdfgraphrequest__define.pro)


SPDFGRAPHREQUEST__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the graph options of this request.

 @returns graph options of this request.

(See external/spdfcdas/spdfgraphrequest__define.pro)


SPDFGRAPHREQUEST__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the image formats of this request.

 @returns reference to strarr of image formats.

(See external/spdfcdas/spdfgraphrequest__define.pro)


SPDFGRAPHREQUEST__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Creates a GraphRequest element using the given XML DOM document with 
 the values of this object.

 @param doc {in} {type=IDLffXMLDOMDocument}
            document in which to create the GraphRequest element.
 @returns a reference to a new IDLffXMLDOMElement representation of
     this object.

(See external/spdfcdas/spdfgraphrequest__define.pro)


SPDFGRAPHREQUEST__DEFINE[8]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfGraphRequest class.

 @field timeInterval time interval of this request.
 @field datasetRequests identifies the datasets for this request.
 @field graphOptions graph options for this request.
 @field imageFormats format options for this request.

(See external/spdfcdas/spdfgraphrequest__define.pro)


SPDFHTTPERRORDIALOG__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class represents an object that is used to report HTTP errors.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfhttperrordialog__define.pro)


SPDFHTTPERRORDIALOG__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfHttpErrorDialog object.

 @returns reference to an SpdfHttpErrorDialog object.

(See external/spdfcdas/spdfhttperrordialog__define.pro)


SPDFHTTPERRORDIALOG__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfhttperrordialog__define.pro)


SPDFHTTPERRORDIALOG__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 This procedure is called when an HTTP error occurs.  This 
 implementation displays a dialog message with some diagnostic 
 information.

 @param responseCode {in} {type=int}
            the HTTP response code of the request causing the error.
 @param responseHeader {in} {type=string}
            the HTTP response header of the request causing the error.
 @param responseFilename {in} {type=string}
            the name of an error response file sent when the error
            occurred.

(See external/spdfcdas/spdfhttperrordialog__define.pro)


SPDFHTTPERRORDIALOG__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfHttpErrorDialog class.

(See external/spdfcdas/spdfhttperrordialog__define.pro)


SPDFHTTPERRORREPORTER__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class represents an object that is used to report HTTP errors.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfhttperrorreporter__define.pro)


SPDFHTTPERRORREPORTER__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfHttpErrorReporter object.

 @returns reference to an SpdfHttpErrorReporter object.

(See external/spdfcdas/spdfhttperrorreporter__define.pro)


SPDFHTTPERRORREPORTER__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfhttperrorreporter__define.pro)


SPDFHTTPERRORREPORTER__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 This procedure is called when an HTTP error occurs.  This default
 implementation merely prints some diagnostic information.

 @param responseCode {in} {type=int}
            the HTTP response code of the request causing the error.
 @param responseHeader {in} {type=string}
            the HTTP response header of the request causing the error.
 @param responseFilename {in} {type=string}
            the name of an error response file sent when the error
            occurred.

(See external/spdfcdas/spdfhttperrorreporter__define.pro)


SPDFHTTPERRORREPORTER__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 This procedure prints some diagnostic information from the given
 HTTP error response file.  It only recognizes the "typical" error
 response from the CDAS web services.

 @param responseFilename {in} {type=string}
            the name of an error response file sent when the error
            occurred.

(See external/spdfcdas/spdfhttperrorreporter__define.pro)


SPDFHTTPERRORREPORTER__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfHttpErrorReporter class.

(See external/spdfcdas/spdfhttperrorreporter__define.pro)


SPDFINSTRUMENTTYPEDESCRIPTION__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the InstrumentTypeDescription
 element from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfinstrumenttypedescription__define.pro)


SPDFINSTRUMENTTYPEDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfInstrumentTypeDescription object.

 @param name {in} {type=string}
            instrument-type name.
 @returns reference to an SpdfInstrumentTypeDescription object.

(See external/spdfcdas/spdfinstrumenttypedescription__define.pro)


SPDFINSTRUMENTTYPEDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfinstrumenttypedescription__define.pro)


SPDFINSTRUMENTTYPEDESCRIPTION__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the name.

 @returns name value.

(See external/spdfcdas/spdfinstrumenttypedescription__define.pro)


SPDFINSTRUMENTTYPEDESCRIPTION__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Prints a textual representation of this object.

(See external/spdfcdas/spdfinstrumenttypedescription__define.pro)


SPDFINSTRUMENTTYPEDESCRIPTION__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfInstrumentTypeDescription class.

 @field name instrument-type name.

(See external/spdfcdas/spdfinstrumenttypedescription__define.pro)


SPDFINVENTORYDESCRIPTION__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the InventoryDescription
 element from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfinventorydescription__define.pro)


SPDFINVENTORYDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfInventoryDescription object.

 @param id {in} {type=string}
            dataset identifier.
 @param timeIntervals {in} {type=objarr of SpdfTimeIntervals}
            time intervals when data is available.
 @returns reference to an SpdfInventoryDescription object.

(See external/spdfcdas/spdfinventorydescription__define.pro)


SPDFINVENTORYDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfinventorydescription__define.pro)


SPDFINVENTORYDESCRIPTION__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the dataset identifier.

 @returns dataset identifier.

(See external/spdfcdas/spdfinventorydescription__define.pro)


SPDFINVENTORYDESCRIPTION__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the time intervals when data is available.

 @returns time intervals when data is available.

(See external/spdfcdas/spdfinventorydescription__define.pro)


SPDFINVENTORYDESCRIPTION__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfInventoryDescription class.

 @field id dataset identifier.
 @field timeIntervals time intervals when data is available.

(See external/spdfcdas/spdfinventorydescription__define.pro)


SPDFOBSERVATORYGROUPDESCRIPTION__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the ObservatoryGroupDescription
 element from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfobservatorygroupdescription__define.pro)


SPDFOBSERVATORYGROUPDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfObservatoryGroupDescription object.

 @param name {in} {type=string}
            name of observatory-group.
 @param observatoryIds {in} {type=strarr}
            identifiers of the observatories in this group.
 @returns reference to an SpdfObservatoryGroupDescription object.

(See external/spdfcdas/spdfobservatorygroupdescription__define.pro)


SPDFOBSERVATORYGROUPDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfobservatorygroupdescription__define.pro)


SPDFOBSERVATORYGROUPDESCRIPTION__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the name of this group.

 @returns name of this group.

(See external/spdfcdas/spdfobservatorygroupdescription__define.pro)


SPDFOBSERVATORYGROUPDESCRIPTION__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the IDs of observatories belonging to this group

 @returns strarr containing the IDs of observatories belonging to this
             group.

(See external/spdfcdas/spdfobservatorygroupdescription__define.pro)


SPDFOBSERVATORYGROUPDESCRIPTION__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Prints a textual representation of this object.

(See external/spdfcdas/spdfobservatorygroupdescription__define.pro)


SPDFOBSERVATORYGROUPDESCRIPTION__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfObservatoryGroupDescription class.

 @field name name of group.
 @field observatoryIds IDs of observatories belonging to this group.

(See external/spdfcdas/spdfobservatorygroupdescription__define.pro)


SPDFTEXTREQUEST__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the TextRequest element from 
 the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdftextrequest__define.pro)


SPDFTEXTREQUEST__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfTextRequest object.

 @param timeInterval {in} {type=SpdfTimeIntervals}
            time interval of the data to include in result.
 @param datasetRequest {in} {type=SpdfDatasetRequest}
            specifies the dataset information.
 @keyword compression {in} {type=strarr} 
            compression algorithms to apply to result file.
 @returns reference to an SpdfTextRequest object.

(See external/spdfcdas/spdftextrequest__define.pro)


SPDFTEXTREQUEST__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdftextrequest__define.pro)


SPDFTEXTREQUEST__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the time interval of this request.

 @returns request's time interval.

(See external/spdfcdas/spdftextrequest__define.pro)


SPDFTEXTREQUEST__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the dataset information.

 @returns dataset specification.

(See external/spdfcdas/spdftextrequest__define.pro)


SPDFTEXTREQUEST__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the compression options.

 @returns compression options.

(See external/spdfcdas/spdftextrequest__define.pro)


SPDFTEXTREQUEST__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Creates a TextRequest element using the given XML DOM document with 
 the values of this object.

 @param doc {in} {type=IDLffXMLDOMDocument}
            document in which to create the TextRequest element.
 @returns a reference to a new IDLffXMLDOMElement representation of
     this object.

(See external/spdfcdas/spdftextrequest__define.pro)


SPDFTEXTREQUEST__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfTextRequest class.

 @field timeInterval time interval of request.
 @field datasetRequest dataset specification.
 @field compression compression options of result.

(See external/spdfcdas/spdftextrequest__define.pro)


SPDFTHUMBNAILDESCRIPTION__DEFINE[10]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfThumbnailDescription class.

 @field type
 @field name
 @field dataset dataset identifier.
 @field timeInterval
 @field varName
 @field options
 @field numFrames number of thumbnail images.
 @field numRows number of rows of thumbnail images.
 @field numCols number of columns of thumbnail images.
 @field titleHeight height of title in pixels.
 @field thumbnailHeight height of thumbnail image in pixels.
 @field thumbnailWidth width of thumbnail image in pixels.
 @field startRecord
 @field myScale
 @field xyStep

(See external/spdfcdas/spdfthumbnaildescription__define.pro)


SPDFTHUMBNAILDESCRIPTION__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the ThumbnailDescription
 element from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfthumbnaildescription__define.pro)


SPDFTHUMBNAILDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfThumbnailDescription object.

 @param type {in} {type=string}
 @param name {in} {type=string}
 @param dataset {in} {type=string}
 @param timeInterval {in} {type=SpdfTimeIntervals}
            time interval covered by the thumbnail images.
 @param varName {in} {type=string}
 @param options {in} {type=long64}
 @param numFrames {in} {type=long}
            number of thumbnail images.
 @param numRows {in} {type=long}
            number of rows of thumbnail images.
 @param numCols {in} {type=long}
            number of columns of thumbnail images.
 @param titleHeight {in} {type=long}
            height of title in pixels.
 @param thumbnailHeight {in} {type=long}
            height of thumbnail image in pixels.
 @param thumbnailWidth {in} {type=long}
            width of thumbnail image in pixels.
 @param startRecord {in} {type=long}
 @param myScale {in} {type=double}
 @param xyStep {in} {type=double}
 @returns reference to an SpdfThumbnailDescription object.

(See external/spdfcdas/spdfthumbnaildescription__define.pro)


SPDFTHUMBNAILDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfthumbnaildescription__define.pro)


SPDFTHUMBNAILDESCRIPTION__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the dataset value.

 @returns dataset value.

(See external/spdfcdas/spdfthumbnaildescription__define.pro)


SPDFTHUMBNAILDESCRIPTION__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the number of frames.

 @returns number of frames.

(See external/spdfcdas/spdfthumbnaildescription__define.pro)


SPDFTHUMBNAILDESCRIPTION__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the number of rows of thumbnail images.

 @returns number of rows of thumbnail images.

(See external/spdfcdas/spdfthumbnaildescription__define.pro)


SPDFTHUMBNAILDESCRIPTION__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the number of columns of thumbnail images.

 @returns number of columns of thumbnail images.

(See external/spdfcdas/spdfthumbnaildescription__define.pro)


SPDFTHUMBNAILDESCRIPTION__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the height of the title.

 @returns height of title in pixels.

(See external/spdfcdas/spdfthumbnaildescription__define.pro)


SPDFTHUMBNAILDESCRIPTION__DEFINE[8]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the height of each thumbnail image.

 @returns height of each thumbnail image in pixels.

(See external/spdfcdas/spdfthumbnaildescription__define.pro)


SPDFTHUMBNAILDESCRIPTION__DEFINE[9]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the width of each thumbnail image.

 @returns width of each thumbnail image in pixels.

(See external/spdfcdas/spdfthumbnaildescription__define.pro)


SPDFTIMEINTERVAL__DEFINE[10]

[Previous Routine] [Next Routine] [List of Routines]
 Get the stop value.

 @returns stop value as an ISO 8601 string.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[11]

[Previous Routine] [Next Routine] [List of Routines]
 Get the start value.

 @returns start value as an cdaweb format string.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[12]

[Previous Routine] [Next Routine] [List of Routines]
 Get the stop value.

 @returns stop value as an cdaweb format string.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[13]

[Previous Routine] [Next Routine] [List of Routines]
 Determines if the start time is less than the stop time.

 @returns true if the start time is less than the stop time.
             Otherwise false.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[14]

[Previous Routine] [Next Routine] [List of Routines]
 Determines if this interval is larger than one day.

 @returns true if this interval is larger than one day.
              Otherwise false.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[15]

[Previous Routine] [Next Routine] [List of Routines]
 Prints a textual representation of this object.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[16]

[Previous Routine] [Next Routine] [List of Routines]
 Creates a TimeInterval element using the given XML DOM document with the
 values of this object.

 @param doc {in} {type=IDLffXMLDOMDocument}
            document in which to create the TimeInterval element.
 @returns a reference to a new IDLffXMLDOMElement representation of
     this object.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[17]

[Previous Routine] [Next Routine] [List of Routines]
 Defines the SpdfTimeInterval class.

 @field start julday start value of interval.
 @field stop julday stop value of interval.
 @field cdawebFormat constant format string for a "cdaweb" time format.
 @field iso8601Format constant format string for an ISO 8601 value.
 @field shortIso8601Format short version of a constant format string 
            for an ISO 8601 value.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the TimeInterval element from 
 the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis 
 System</a> (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfTimeInterval object.

 @param start {in} {type=string/julday}
            start time of interval.  Value may be either an
            <a href="https://en.wikipedia.org/wiki/ISO_8601">
            ISO 8601</a> date/time string or a julday value.
 @param stop {in} {type=string/julday}
            stop time of interval.  Value may be either an
            <a href="https://en.wikipedia.org/wiki/ISO_8601">
            ISO 8601</a> date/time string or a julday value.
 @returns reference to an SpdfTimeInterval object.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Get the start value.

 @returns julday start value.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Sets the start value.

 @param value {in} {type=julday} new value

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Get the stop value.

 @returns julday stop value.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Sets the stop value.

 @param value {in} {type=julday} new value

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[7]

[Previous Routine] [Next Routine] [List of Routines]
 Converts the given ISO 8601 time value string into the 
 corresponding julday value.

 @param value {in} {type=string}
            ISO 8601 date/time value
 @returns julday value corresponding to the given iso8601 value.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[8]

[Previous Routine] [Next Routine] [List of Routines]
 Converts the given julday value into the corresponding ISO 8601 
 time value string.

 @param value {in} {type=string}
            julday value.
 @returns ISO 8601 date/time value corresponding to the given 
     julday value.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFTIMEINTERVAL__DEFINE[9]

[Previous Routine] [Next Routine] [List of Routines]
 Get the start value.

 @returns start value as an ISO 8601 string.

(See external/spdfcdas/spdftimeinterval__define.pro)


SPDFVARIABLEDESCRIPTION__DEFINE[1]

[Previous Routine] [Next Routine] [List of Routines]
 This class is an IDL representation of the VariableDescription
 element from the
 <a href="https://cdaweb.gsfc.nasa.gov/">Coordinated Data Analysis System</a>
 (CDAS) XML schema.

 @copyright Copyright (c) 2010-2017 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.

 @author B. Harris

(See external/spdfcdas/spdfvariabledescription__define.pro)


SPDFVARIABLEDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Creates an SpdfVariableDescription object.

 @param name {in} {type=string}
            name of variable.
 @param shortDescription {in} {type=string}
            short description of varaible.
 @param longDescription {in} {type=string}
            long description of varaible.
 @keyword parent {in} {type=string} {optional}
            name of parent variable.
 @keyword children {in} {type=strarr} {optional}
            names of child variables
 @returns reference to an SpdfVariableDescription object.

(See external/spdfcdas/spdfvariabledescription__define.pro)


SPDFVARIABLEDESCRIPTION__DEFINE[2]

[Previous Routine] [Next Routine] [List of Routines]
 Performs cleanup operations when this object is destroyed.

(See external/spdfcdas/spdfvariabledescription__define.pro)


SPDFVARIABLEDESCRIPTION__DEFINE[3]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the name of this variable.

 @returns name of this variable.

(See external/spdfcdas/spdfvariabledescription__define.pro)


SPDFVARIABLEDESCRIPTION__DEFINE[4]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the short description of this variable.

 @returns short description of this variable.

(See external/spdfcdas/spdfvariabledescription__define.pro)


SPDFVARIABLEDESCRIPTION__DEFINE[5]

[Previous Routine] [Next Routine] [List of Routines]
 Gets the long description of this variable.

 @returns long description of this variable.

(See external/spdfcdas/spdfvariabledescription__define.pro)


SPDFVARIABLEDESCRIPTION__DEFINE[6]

[Previous Routine] [Next Routine] [List of Routines]
 Prints a textual representation of this object.

(See external/spdfcdas/spdfvariabledescription__define.pro)


SPDFVARIABLEDESCRIPTION__DEFINE[7]

[Previous Routine] [List of Routines]
 Defines the SpdfVariableDescription class.

 @field name varable's name.
 @field shortDescription short description of variable.
 @field longDescription long description of variable.
 @field parent name of parent variable.
 @field children names of child variables.

(See external/spdfcdas/spdfvariabledescription__define.pro)