Official websites use .gov
A
.gov website belongs to an official government
organization in the United States.
Secure .gov websites use HTTPS
A
lock (
) or https:// means you’ve safely connected to
the .gov website. Share sensitive information only on official,
secure websites.
::: content
[;{.source}]{.comments} {.source}[; NOSA HEADER START{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; The contents of this file are subject to the terms of the NASA Open {.source}]{.comments} {.source}[; Source Agreement (NOSA), Version 1.3 only (the "Agreement"). You may {.source}]{.comments} {.source}[; not use this file except in compliance with the Agreement.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; You can obtain a copy of the agreement at{.source}]{.comments} {.source}[; docs/NASA_Open_Source_Agreement_1.3.txt{.source}]{.comments} {.source}[; or {.source}]{.comments} {.source}[; http://sscweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; See the Agreement for the specific language governing permissions{.source}]{.comments} {.source}[; and limitations under the Agreement.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; When distributing Covered Code, include this NOSA HEADER in each{.source}]{.comments} {.source}[; file and include the Agreement file at {.source}]{.comments} {.source}[; docs/NASA_Open_Source_Agreement_1.3.txt. If applicable, add the {.source}]{.comments} {.source}[; following below this NOSA HEADER, with the fields enclosed by {.source}]{.comments} {.source}[; brackets "[]" replaced with your own identifying information: {.source}]{.comments} {.source}[; Portions Copyright [yyyy] [name of copyright owner]{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; NOSA HEADER END{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; Copyright (c) 2013 United States Government as represented by the {.source}]{.comments} {.source}[; National Aeronautics and Space Administration. No copyright is claimed {.source}]{.comments} {.source}[; in the United States under Title 17, U.S.Code. All Other Rights Reserved.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;+{.source}]{.comments} {.source}[; This class is an IDL representation of the Tsyganenko96BFieldModel{.source}]{.comments} {.source}[; element from the{.source}]{.comments} {.source}[; <a href="http://sscweb.gsfc.nasa.gov/">Satellite Situation Center</a>{.source}]{.comments} {.source}[; (SSC) XML schema.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @copyright Copyright (c) 2013 United States Government as represented{.source}]{.comments} {.source}[; by the National Aeronautics and Space Administration. No{.source}]{.comments} {.source}[; copyright is claimed in the United States under Title 17,{.source}]{.comments} {.source}[; U.S.Code. All Other Rights Reserved.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @author B. Harris{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[;+{.source}]{.comments} {.source}[; Creates an SpdfTsyganenko96BFieldModel object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @keyword solarWindPressure {in} {optional} {type=double}{.source}]{.comments} {.source}[; solar wind pressure (range: 0 - 30 nP, default=2.1).{.source}]{.comments} {.source}[; @keyword dstIndex {in} {optional} {type=int}{.source}]{.comments} {.source}[; Disturbance Storm Time (DST) index {.source}]{.comments} {.source}[; (range: -400 - 200 nT, default=-20).{.source}]{.comments} {.source}[; @keyword byImf {in} {optional} {type=double}{.source}]{.comments} {.source}[; BY Interplanetary Magnetic Field (IMF){.source}]{.comments} {.source}[; (range: -100 - 100 nT, default=0.0).{.source}]{.comments} {.source}[; @keyword bzImf {in} {optional} {type=double}{.source}]{.comments} {.source}[; BZ Interplanetary Magnetic Field (IMF){.source}]{.comments} {.source}[; (range: -100 - 100 nT, default=0.0).{.source}]{.comments} {.source}[; @returns reference to an SpdfTsyganenko96BFieldModel object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfTsyganenko96BFieldModel::init:source}function SpdfTsyganenko96BFieldModel::init, $ solarWindPressure = solarWindPressure, $ dstIndex = dstIndex, $ byImf = byImf, $ bzImf = bzImf compile_opt idl2 if keyword_set(solarWindPressure) then begin self.solarWindPressure = solarWindPressure endif else begin self.solarWindPressure = 2.1D endelse if keyword_set(dstIndex) then begin self.dstIndex = dstIndex endif else begin self.dstIndex = -20L endelse if keyword_set(byImf) then begin self.byImf = byImf endif else begin self.byImf = 0.0D endelse if keyword_set(bzImf) then begin self.bzImf = bzImf endif else begin self.bzImf = 0.0D endelse return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfTsyganenko96BFieldModel::cleanup:source}pro SpdfTsyganenko96BFieldModel::cleanup compile_opt idl2 end {.source}[;+{.source}]{.comments} {.source}[; Get the solar wind pressure value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns the solar wind pressure value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfTsyganenko96BFieldModel::getSolarWindPressure:source}function SpdfTsyganenko96BFieldModel::getSolarWindPressure compile_opt idl2 return, self.solarWindPressure end {.source}[;+{.source}]{.comments} {.source}[; Creates an ExternalBFieldModel element using the given XML DOM {.source}]{.comments} {.source}[; document with the values of this object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @param doc {in} {type=IDLffXMLDOMDocument}{.source}]{.comments} {.source}[; document in which to create the DataRequest element.{.source}]{.comments} {.source}[; @returns a reference to a new IDLffXMLDOMElement representation of{.source}]{.comments} {.source}[; this object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfTsyganenko96BFieldModel::createDomElement:source}function SpdfTsyganenko96BFieldModel::createDomElement, $ doc compile_opt idl2 bFieldModelElement = doc->createElement('ExternalBFieldModel') bFieldModelElement->setAttribute, 'xmlns:xsi', $ 'http://www.w3.org/2001/XMLSchema-instance' bFieldModelElement->setAttribute, 'xsi:type', $ 'Tsyganenko96BFieldModel' swpElement = doc->createElement('SolarWindPressure') ovoid = bFieldModelElement->appendChild(swpElement) swpNode = doc->createTextNode( $ string(self.solarWindPressure, format='(%"%d")')) ovoid = swpElement->appendChild(swpNode) dstIndexElement = doc->createElement('DstIndex') ovoid = bFieldModelElement->appendChild(dstIndexElement) dstIndexNode = doc->createTextNode( $ string(self.dstIndex, format='(%"%d")')) ovoid = dstIndexElement->appendChild(dstIndexNode) byImfElement = doc->createElement('ByImf') ovoid = bFieldModelElement->appendChild(byImfElement) byImfNode = doc->createTextNode( $ string(self.byImf, format='(%"%d")')) ovoid = byImfElement->appendChild(byImfNode) bzImfElement = doc->createElement('BzImf') ovoid = bFieldModelElement->appendChild(bzImfElement) bzImfNode = doc->createTextNode( $ string(self.bzImf, format='(%"%d")')) ovoid = bzImfElement->appendChild(bzImfNode) return, bFieldModelElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfTsyganenko96BFieldModel class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field solarWindPressure solar wind pressure {.source}]{.comments} {.source}[; (range: 0 - 30 nP, default=2.1).{.source}]{.comments} {.source}[; @field dstIndex Disturbance Storm Time (DST) index {.source}]{.comments} {.source}[; (range: -400 - 200 nT, default=-20).{.source}]{.comments} {.source}[; @field byImf BY Interplanetary Magnetic Field (IMF){.source}]{.comments} {.source}[; (range: -100 - 100 nT, default=0.0).{.source}]{.comments} {.source}[; @field bzImf BZ Interplanetary Magnetic Field (IMF){.source}]{.comments} {.source}[; (range: -100 - 100 nT, default=0.0).{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfTsyganenko96BFieldModel__define:source}pro SpdfTsyganenko96BFieldModel__define compile_opt idl2 struct = { SpdfTsyganenko96BFieldModel, $ inherits SpdfExternalBFieldModel, $ solarWindPressure:2.1D, $ dstIndex:-20L, $ byImf:0.0D, $ bzImf:0.0D $ } end {.source}
:::
