![[attach.png]](idldoc-resources/attach.png)
./
spdfcdfrequest__define.pro
This class is an IDL representation of the CdfRequest element from the Coordinated Data Analysis System (CDAS) XML schema.
Author information
- Author
B. Harris
- 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.
Class description for SpdfCdfRequest
Properties
Properties in SpdfCdfRequest
- binData init
- cdfFormat init
- cdfVersion init
Fields
Fields in SpdfCdfRequest
- binData ptr_new()
data binning parameters.
- cdfFormat ''
indicates the desired format of the CDF file.
- cdfVersion 0S
indicates the desired version of the CDF file.
- datasetRequest ptr_new()
identifies the dataset for this request.
- timeIntervals ptr_new()
time intervals of this request.
Routines
Routines from spdfcdfrequest__define.pro
result = SpdfCdfRequest::init(timeIntervals, datasetRequest, cdfVersion=int, cdfFormat=string [, binData=SpdfBinData])Creates an SpdfCdfRequest object.
SpdfCdfRequest::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfCdfRequest::getTimeIntervals()Gets the time intervals.
result = SpdfCdfRequest::getDatasetRequest()Gets the dataset request.
result = SpdfCdfRequest::getCdfVersion()Gets the CDF version.
result = SpdfCdfRequest::getCdfFormat()Gets the CDF format.
result = SpdfCdfRequest::getBinData()Gets the binData parameters.
result = SpdfCdfRequest::createDomElement(doc)Creates a CdfRequest element using the given XML DOM document with the values of this object.
SpdfCdfRequest__defineDefines the SpdfCdfRequest class.
Routine details
top source SpdfCdfRequest::init
result = SpdfCdfRequest::init(timeIntervals, datasetRequest, cdfVersion=int, cdfFormat=string [, binData=SpdfBinData])
Creates an SpdfCdfRequest object.
Return value
reference to an SpdfCdfRequest object.
Parameters
- timeIntervals in type=objarr of SpdfTimeIntervals
time intervals that the requested CDF is to contain data for.
- 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.
Keywords
- cdfVersion in type=int default=3
version of CDF file.
- cdfFormat in type=string default=Binary
format of CDF file.
- binData in optional type=SpdfBinData
data binning parameters to apply to result file.
top source SpdfCdfRequest::cleanup
SpdfCdfRequest::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfCdfRequest::getTimeIntervals
result = SpdfCdfRequest::getTimeIntervals()
Gets the time intervals.
Return value
reference to objarr of time intervals.
top source SpdfCdfRequest::getDatasetRequest
result = SpdfCdfRequest::getDatasetRequest()
Gets the dataset request.
Return value
reference to dataset request.
top source SpdfCdfRequest::getCdfVersion
result = SpdfCdfRequest::getCdfVersion()
Gets the CDF version.
Return value
CDF version.
top source SpdfCdfRequest::getCdfFormat
result = SpdfCdfRequest::getCdfFormat()
Gets the CDF format.
Return value
CDF format.
top source SpdfCdfRequest::getBinData
result = SpdfCdfRequest::getBinData()
Gets the binData parameters.
Return value
binData parameters.
top source SpdfCdfRequest::createDomElement
result = SpdfCdfRequest::createDomElement(doc)
Creates a CdfRequest element using the given XML DOM document with the values of this object.
Return value
a reference to a new IDLffXMLDOMElement representation of this object.
Parameters
- doc in type=IDLffXMLDOMDocument
document in which to create the CdfRequest element.
File attributes
| Modification date: | Mon Sep 17 12:21:08 2018 |
| Lines: | 81 |
CDAS Feedback.