![[attach.png]](idldoc-resources/attach.png)
./
spdfbfieldtraceoptions__define.pro
This class is an IDL representation of the BFieldTraceOptions 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 SpdfBFieldTraceOptions
Properties
Properties in SpdfBFieldTraceOptions
- coordinateSystem init
- fieldLineLength init
- footpointLatitude init
- footpointLongitude init
- hemisphere init
Routines
Routines from spdfbfieldtraceoptions__define.pro
result = SpdfBFieldTraceOptions::init( [coordinateSystem=string] [, hemisphere=string] [, /footpointLatitude] [, /footpointLongitude] [, /fieldLineLength])Creates an SpdfBFieldTraceOptions object.
SpdfBFieldTraceOptions::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfBFieldTraceOptions::getCoordinateSystem()Gets the coordinate system value.
result = SpdfBFieldTraceOptions::getHemisphere()Gets the hemisphere value.
result = SpdfBFieldTraceOptions::getFootpointLatitude()Gets the footpoint latitude value.
result = SpdfBFieldTraceOptions::getFootpointLongitude()Gets the footpoint longitude value.
result = SpdfBFieldTraceOptions::getFieldLineLength()Gets the field-line length value.
result = SpdfBFieldTraceOptions::createDomElement(doc)Creates an BFieldTraceOptions element using the given XML DOM document with the values of this object.
SpdfBFieldTraceOptions__defineDefines the SpdfBFieldTraceOptions class.
Routine details
top source SpdfBFieldTraceOptions::init
result = SpdfBFieldTraceOptions::init( [coordinateSystem=string] [, hemisphere=string] [, /footpointLatitude] [, /footpointLongitude] [, /fieldLineLength])
Creates an SpdfBFieldTraceOptions object.
Return value
reference to an SpdfBFieldTraceOptions object.
Keywords
- coordinateSystem in optional type=string default='Gse'
specifies the coordinate system is to be included in the output.
- hemisphere in optional type=string default='North'
specifies the hemisphere to be included in the output.
- footpointLatitude in optional type=boolean default=false
specifies whether the footpoint latitude value is to be included in the output.
- footpointLongitude in optional type=boolean default=false
specifies whether the footpoint longitude value is to be included in the output.
- fieldLineLength in optional type=boolean default=false
specifies whether the field line length value is to be included in the output.
top source SpdfBFieldTraceOptions::cleanup
SpdfBFieldTraceOptions::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfBFieldTraceOptions::getCoordinateSystem
result = SpdfBFieldTraceOptions::getCoordinateSystem()
Gets the coordinate system value.
Return value
coordinate system value.
top source SpdfBFieldTraceOptions::getHemisphere
result = SpdfBFieldTraceOptions::getHemisphere()
Gets the hemisphere value.
Return value
hemisphere value.
top source SpdfBFieldTraceOptions::getFootpointLatitude
result = SpdfBFieldTraceOptions::getFootpointLatitude()
Gets the footpoint latitude value.
Return value
footpoint latitude value.
top source SpdfBFieldTraceOptions::getFootpointLongitude
result = SpdfBFieldTraceOptions::getFootpointLongitude()
Gets the footpoint longitude value.
Return value
footpoint longitude value.
top source SpdfBFieldTraceOptions::getFieldLineLength
result = SpdfBFieldTraceOptions::getFieldLineLength()
Gets the field-line length value.
Return value
field-line length value.
top source SpdfBFieldTraceOptions::createDomElement
result = SpdfBFieldTraceOptions::createDomElement(doc)
Creates an BFieldTraceOptions 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: | 115 |
SSC Feedback.