./
spdfgraphrequest__define.pro
This class is an IDL representation of the GraphRequest 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 SpdfGraphRequest
Properties
Properties in SpdfGraphRequest
- binData init
- graphOptions init
- imageFormats init
Fields
Fields in SpdfGraphRequest
- binData ptr_new()
data binning parameters.
- datasetRequests ptr_new()
identifies the datasets for this request.
- graphOptions ptr_new()
graph options for this request.
- imageFormats ptr_new()
format options for this request.
- timeInterval ptr_new()
time interval of this request.
Routines
Routines from spdfgraphrequest__define.pro
result = SpdfGraphRequest::init(timeInterval, datasetRequests, graphOptions=int, imageFormats=strarr [, binData=SpdfBinData])
Creates an SpdfGraphRequest object.
SpdfGraphRequest::cleanup
Performs cleanup operations when this object is destroyed.
result = SpdfGraphRequest::getTimeInterval()
Gets the time interval of this request.
result = SpdfGraphRequest::getDatasetRequests()
Gets the dataset information of this request.
result = SpdfGraphRequest::getGraphOptions()
Gets the graph options of this request.
result = SpdfGraphRequest::getImageFormats()
Gets the image formats of this request.
result = SpdfGraphRequest::getBinData()
Gets the binData parameters.
result = SpdfGraphRequest::createDomElement(doc)
Creates a GraphRequest element using the given XML DOM document with the values of this object.
SpdfGraphRequest__define
Defines the SpdfGraphRequest class.
Routine details
top source SpdfGraphRequest::init
result = SpdfGraphRequest::init(timeInterval, datasetRequests, graphOptions=int, imageFormats=strarr [, binData=SpdfBinData])
Creates an SpdfGraphRequest object.
Return value
reference to an SpdfGraphRequest object.
Parameters
- timeInterval in type=SpdfTimeInterval
time interval that the requested graph is to contain data for.
- datasetRequests in type=objarr of SpdfDatasetRequests
specifies the dataset information.
Keywords
- graphOptions in type=int default=0
graph option bit-mask value.
- imageFormats in type=strarr default=PNG
format of graph file.
- binData in optional type=SpdfBinData
data binning parameters to apply to result file.
top source SpdfGraphRequest::cleanup
SpdfGraphRequest::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfGraphRequest::getTimeInterval
result = SpdfGraphRequest::getTimeInterval()
Gets the time interval of this request.
Return value
time interval of this request.
top source SpdfGraphRequest::getDatasetRequests
result = SpdfGraphRequest::getDatasetRequests()
Gets the dataset information of this request.
Return value
reference to objarr of SpdfDatasetRequest's.
top source SpdfGraphRequest::getGraphOptions
result = SpdfGraphRequest::getGraphOptions()
Gets the graph options of this request.
Return value
graph options of this request.
top source SpdfGraphRequest::getImageFormats
result = SpdfGraphRequest::getImageFormats()
Gets the image formats of this request.
Return value
reference to strarr of image formats.
top source SpdfGraphRequest::getBinData
result = SpdfGraphRequest::getBinData()
Gets the binData parameters.
Return value
binData parameters.
top source SpdfGraphRequest::createDomElement
result = SpdfGraphRequest::createDomElement(doc)
Creates a GraphRequest 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 GraphRequest element.
File attributes
Modification date: | Fri May 18 14:03:12 2018 |
Lines: | 89 |
CDAS Feedback.