![[attach.png]](idldoc-resources/attach.png)
./
spdftextrequest__define.pro
This class is an IDL representation of the TextRequest 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 SpdfTextRequest
Properties
Properties in SpdfTextRequest
- binData init
- compression init
- format init
Fields
Fields in SpdfTextRequest
- binData ptr_new()
data binning parameters.
- compression ptr_new()
compression options of result.
- datasetRequest ptr_new()
dataset specification.
- format ''
format of result.
- timeInterval ptr_new()
time interval of request.
Routines
Routines from spdftextrequest__define.pro
result = SpdfTextRequest::init(timeInterval, datasetRequest [, compression=strarr] [, format=string] [, binData=SpdfBinData])Creates an SpdfTextRequest object.
SpdfTextRequest::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfTextRequest::getTimeInterval()Gets the time interval of this request.
result = SpdfTextRequest::getDatasetRequest()Gets the dataset information.
result = SpdfTextRequest::getCompression()Gets the compression options.
result = SpdfTextRequest::getFormat()Gets the format option.
result = SpdfTextRequest::getBinData()Gets the binData parameters.
result = SpdfTextRequest::createDomElement(doc)Creates a TextRequest element using the given XML DOM document with the values of this object.
SpdfTextRequest__defineDefines the SpdfTextRequest class.
Routine details
top source SpdfTextRequest::init
result = SpdfTextRequest::init(timeInterval, datasetRequest [, compression=strarr] [, format=string] [, binData=SpdfBinData])
Creates an SpdfTextRequest object.
Return value
reference to an SpdfTextRequest object.
Parameters
- timeInterval in type=SpdfTimeIntervals
time interval of the data to include in result.
- datasetRequest in type=SpdfDatasetRequest
specifies the dataset information.
Keywords
- compression in optional type=strarr
compression algorithms to apply to result file.
- format in optional type=string default='Plain'
format of result file. Valid values are: Plain, CSV.
- binData in optional type=SpdfBinData
data binning parameters to apply to result file.
top source SpdfTextRequest::cleanup
SpdfTextRequest::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfTextRequest::getTimeInterval
result = SpdfTextRequest::getTimeInterval()
Gets the time interval of this request.
Return value
request's time interval.
top source SpdfTextRequest::getDatasetRequest
result = SpdfTextRequest::getDatasetRequest()
Gets the dataset information.
Return value
dataset specification.
top source SpdfTextRequest::getCompression
result = SpdfTextRequest::getCompression()
Gets the compression options.
Return value
compression options.
top source SpdfTextRequest::getFormat
result = SpdfTextRequest::getFormat()
Gets the format option.
Return value
format option.
top source SpdfTextRequest::getBinData
result = SpdfTextRequest::getBinData()
Gets the binData parameters.
Return value
binData parameters.
top source SpdfTextRequest::createDomElement
result = SpdfTextRequest::createDomElement(doc)
Creates a TextRequest 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 TextRequest element.
File attributes
| Modification date: | Wed May 30 11:42:39 2018 |
| Lines: | 86 |
CDAS Feedback.