![[attach.png]](idldoc-resources/attach.png)
./
spdfbfieldmodel__define.pro
This class is an IDL representation of the BFieldModel 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 SpdfBFieldModel
Properties
Properties in SpdfBFieldModel
- externalBFieldModel init
- internalBFieldModel init
- traceStopAltitude init
Routines
Routines from spdfbfieldmodel__define.pro
result = SpdfBFieldModel::init(internalBFieldModel=string, externalBFieldModel=SpdfExternalBFieldModel [, traceStopAltitude=int])Creates an SpdfBFieldModel object.
SpdfBFieldModel::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfBFieldModel::getInternalBFieldModel()Gets the internal B field model value.
result = SpdfBFieldModel::getExternalBFieldModel()Gets the external B field model.
result = SpdfBFieldModel::getTraceStopAltitude()Gets the trace stop altitude value.
result = SpdfBFieldModel::createDomElement(doc)Creates an BFieldModel element using the given XML DOM document with the values of this object.
SpdfBFieldModel__defineDefines the SpdfBFieldModel class.
Routine details
top source SpdfBFieldModel::init
result = SpdfBFieldModel::init(internalBFieldModel=string, externalBFieldModel=SpdfExternalBFieldModel [, traceStopAltitude=int])
Creates an SpdfBFieldModel object.
Return value
reference to an SpdfBFieldModel object.
Keywords
- internalBFieldModel in type=string default="IGRF"
internal magnetic field model (valid values: "IGRF", "SimpleDipole").
- externalBFieldModel in type=SpdfExternalBFieldModel default=SpdfTsyganenko89c
external magnetic field model.
- traceStopAltitude in optional type=int default=100
stop altitude for downward tracing of field.
top source SpdfBFieldModel::cleanup
SpdfBFieldModel::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfBFieldModel::getInternalBFieldModel
result = SpdfBFieldModel::getInternalBFieldModel()
Gets the internal B field model value.
Return value
internal B field model value.
top source SpdfBFieldModel::getExternalBFieldModel
result = SpdfBFieldModel::getExternalBFieldModel()
Gets the external B field model.
Return value
a reference to the external B field model.
top source SpdfBFieldModel::getTraceStopAltitude
result = SpdfBFieldModel::getTraceStopAltitude()
Gets the trace stop altitude value.
Return value
trace stop altitude value.
top source SpdfBFieldModel::createDomElement
result = SpdfBFieldModel::createDomElement(doc)
Creates an BFieldModel 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: | 67 |
SSC Feedback.