![[attach.png]](idldoc-resources/attach.png)
./
spdfsscdatarequest__define.pro
This class is an IDL representation of the DataRequest element from the Satellite Situation Center (SSC) XML schema.
Author information
- Author
B. Harris
- Copyright
Copyright (c) 2013-2016 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 SpdfSscDataRequest
Inheritance
All ancestor classes: SpdfLocationRequest SpdfRequest
Properties
Properties in SpdfSscDataRequest
- bFieldModel init
- description init
- formatOptions init
- locationFilterOptions init
- regionOptions init
Routines
Methods inherited from SpdfRequest
result = SpdfRequest::getDescription()result = SpdfRequest::init(timeInterval [, description=string] [, bFieldModel=SpdfBFieldModel])result = SpdfRequest::createDomElement(doc, subClassName)SpdfRequest::cleanupresult = SpdfRequest::getTimeInterval()result = SpdfRequest::getBFieldModel()
Methods inherited from SpdfLocationRequest
SpdfLocationRequest::cleanupresult = SpdfLocationRequest::init(timeInterval, satellites [, description=string] [, bFieldModel=SpdfBFieldModel])result = SpdfLocationRequest::getSatellites()result = SpdfLocationRequest::createDomElement(doc, subClassName)
Routines from spdfsscdatarequest__define.pro
result = SpdfSscDataRequest::init(timeInterval, satellites, outputOptions [, description=string] [, bFieldModel=SpdfBFieldModel] [, regionOptions=SpdfRegionOptions] [, locationFilterOptions=SpdfLocationFilterOptions] [, formatOptions=SpdfFormatOptions])Creates an SpdfSscDataRequest object.
SpdfSscDataRequest::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfSscDataRequest::getOutputOptions()Gets the output options.
result = SpdfSscDataRequest::createDomElement(doc)Creates a DataRequest element using the given XML DOM document with the values of this object.
SpdfSscDataRequest__defineDefines the SpdfSscDataRequest class.
Routine details
top source SpdfSscDataRequest::init
result = SpdfSscDataRequest::init(timeInterval, satellites, outputOptions [, description=string] [, bFieldModel=SpdfBFieldModel] [, regionOptions=SpdfRegionOptions] [, locationFilterOptions=SpdfLocationFilterOptions] [, formatOptions=SpdfFormatOptions])
Creates an SpdfSscDataRequest object.
Return value
reference to an SpdfSscDataRequest object.
Parameters
- timeInterval in type=SpdfTimeInterval
time interval of this request.
- satellites in type=SpdfSatelliteSpecification objarr
requested satellites.
- outputOptions in type=SpdfOutputOptions
requested output options.
Keywords
- description in optional type=string
a textual description of this request.
- bFieldModel in optional type=SpdfBFieldModel
magnetic field model to use. If not given, a default model of IGRF and Tsyganenko 89c with KP values of 3-,3,3+ is used.
- regionOptions in optional type=SpdfRegionOptions
requested region options.
- locationFilterOptions in optional type=SpdfLocationFilterOptions
requested location filter options.
- formatOptions in optional type=SpdfFormatOptions
requested format options.
top source SpdfSscDataRequest::cleanup
SpdfSscDataRequest::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfSscDataRequest::getOutputOptions
result = SpdfSscDataRequest::getOutputOptions()
Gets the output options.
Return value
reference to output options.
top source SpdfSscDataRequest::createDomElement
result = SpdfSscDataRequest::createDomElement(doc)
Creates a DataRequest 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 DataRequest element.
File attributes
| Modification date: | Fri May 13 08:54:13 2022 |
| Lines: | 87 |
SSC Feedback.