![[attach.png]](idldoc-resources/attach.png)
./
spdfrequest__define.pro
This class is an IDL representation of the Request element from the Satellite Situation Center (SSC) XML schema.
Author information
- Author
B. Harris
- Copyright
Copyright (c) 2013 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 SpdfRequest
Subclasses: SpdfLocationRequest
Properties
Properties in SpdfRequest
- bFieldModel init
- description init
Routines
Routines from spdfrequest__define.pro
result = SpdfRequest::init(timeInterval [, description=string] [, bFieldModel=SpdfBFieldModel])Creates an SpdfRequest object.
SpdfRequest::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfRequest::getDescription()Gets the description value.
result = SpdfRequest::getTimeInterval()Gets the timeInterval value.
result = SpdfRequest::getBFieldModel()Gets the bFieldModel value.
result = SpdfRequest::createDomElement(doc, subClassName)Creates a Request element using the given XML DOM document with the values of this object.
SpdfRequest__defineDefines the SpdfRequest class.
Routine details
top source SpdfRequest::init
result = SpdfRequest::init(timeInterval [, description=string] [, bFieldModel=SpdfBFieldModel])
Creates an SpdfRequest object.
Return value
reference to an SpdfRequest object.
Parameters
- timeInterval in type=SpdfTimeInterval
time interval of this request.
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, the Tsyganenko 89c model is used.
top source SpdfRequest::cleanup
SpdfRequest::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfRequest::getDescription
result = SpdfRequest::getDescription()
Gets the description value.
Return value
description value.
top source SpdfRequest::getTimeInterval
result = SpdfRequest::getTimeInterval()
Gets the timeInterval value.
Return value
reference to timeInterval
top source SpdfRequest::getBFieldModel
result = SpdfRequest::getBFieldModel()
Gets the bFieldModel value.
Return value
reference to bFieldModel
top source SpdfRequest::createDomElement
result = SpdfRequest::createDomElement(doc, subClassName)
Creates a Request 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 Request element.
- subClassName in type=string
name of sub-class.
File attributes
| Modification date: | Fri May 13 08:54:13 2022 |
| Lines: | 63 |
SSC Feedback.