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 Tsyganenko89cBFieldModel{.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 SpdfTsyganenko89cBFieldModel object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @keyword keyParameterValues {in} {optional} {type=string} {.source}]{.comments} {.source}[; {default='KP3_3_3'}{.source}]{.comments} {.source}[; Model's key parameter values. Must be one of the {.source}]{.comments} {.source}[; following: KP0_0, KP1_1_1, KP2_2_2, KP3_3_3, KP4_4_4,{.source}]{.comments} {.source}[; KP5_5_5, or KP6.{.source}]{.comments} {.source}[; @returns reference to an SpdfTsyganenko89cBFieldModel object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfTsyganenko89cBFieldModel::init:source}function SpdfTsyganenko89cBFieldModel::init, $ keyParameterValues = keyParameterValues compile_opt idl2 if keyword_set(keyParameterValues) then begin self.keyParameterValues = keyParameterValues endif else begin self.keyParameterValues = 'KP3_3_3' endelse return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfTsyganenko89cBFieldModel::cleanup:source}pro SpdfTsyganenko89cBFieldModel::cleanup compile_opt idl2 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}[]{#SpdfTsyganenko89cBFieldModel::createDomElement:source}function SpdfTsyganenko89cBFieldModel::createDomElement, $ doc compile_opt idl2 bFieldModelElement = doc->createElement('ExternalBFieldModel') bFieldModelElement->setAttribute, 'xmlns:xsi', $ 'http://www.w3.org/2001/XMLSchema-instance' bFieldModelElement->setAttribute, 'xsi:type', $ 'Tsyganenko89cBFieldModel' kpElement = doc->createElement('KeyParameterValues') ovoid = bFieldModelElement->appendChild(kpElement) kpNode = doc->createTextNode(self.keyParameterValues) ovoid = kpElement->appendChild(kpNode) return, bFieldModelElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfTsyganenko89cBFieldModel class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field keyParameterValues model's key parameter values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfTsyganenko89cBFieldModel__define:source}pro SpdfTsyganenko89cBFieldModel__define compile_opt idl2 struct = { SpdfTsyganenko89cBFieldModel, $ inherits SpdfExternalBFieldModel, $ keyParameterValues:'' $ } end {.source}
:::
