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 DistanceFromOptions{.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 SpdfDistanceFromOptions object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @keyword neutralSheet {in} {optional} {type=boolean} {default=false}{.source}]{.comments} {.source}[; specifies whether the distance from the neutral sheet{.source}]{.comments} {.source}[; is to be included in the output.{.source}]{.comments} {.source}[; @keyword bowShock {in} {optional} {type=boolean} {default=false}{.source}]{.comments} {.source}[; specifies whether the distance from the bow shock is {.source}]{.comments} {.source}[; to be included in the output.{.source}]{.comments} {.source}[; @keyword mPause {in} {optional} {type=boolean} {default=false}{.source}]{.comments} {.source}[; specifies whether the distance from the magneto pause{.source}]{.comments} {.source}[; is to be included in the output.{.source}]{.comments} {.source}[; @keyword bGseXYZ {in} {optional} {type=boolean} {default=false}{.source}]{.comments} {.source}[; specifies whether the B GSE X, Y, Z values is to be{.source}]{.comments} {.source}[; included in the output.{.source}]{.comments} {.source}[; @returns reference to an SpdfDistanceFromOptions object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfDistanceFromOptions::init:source}function SpdfDistanceFromOptions::init, $ neutralSheet = neutralSheet, $ bowShock = bowShock, $ mPause = mPause, $ bGseXYZ = bGseXYZ compile_opt idl2 if keyword_set(neutralSheet) then begin self.neutralSheet = neutralSheet endif else begin self.neutralSheet = 0b endelse if keyword_set(bowShock) then begin self.bowShock = bowShock endif else begin self.bowShock = 0b endelse if keyword_set(mPause) then begin self.mPause = mPause endif else begin self.mPause = 0b endelse if keyword_set(bGseXYZ) then begin self.bGseXYZ = bGseXYZ endif else begin self.bGseXYZ = 0b endelse return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfDistanceFromOptions::cleanup:source}pro SpdfDistanceFromOptions::cleanup compile_opt idl2 end {.source}[;+{.source}]{.comments} {.source}[; Gets the distance from the neutral sheet value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns distance from the neutral sheet value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfDistanceFromOptions::getNeutralSheet:source}function SpdfDistanceFromOptions::getNeutralSheet compile_opt idl2 return, self.neutralSheet end {.source}[;+{.source}]{.comments} {.source}[; Gets the distance from the bow shock value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns distance from the bow shock value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfDistanceFromOptions::getBowShock:source}function SpdfDistanceFromOptions::getBowShock compile_opt idl2 return, self.bowShock end {.source}[;+{.source}]{.comments} {.source}[; Gets the distance from the magneto pause value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns distance from the magneto pause value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfDistanceFromOptions::getMPause:source}function SpdfDistanceFromOptions::getMPause compile_opt idl2 return, self.mPause end {.source}[;+{.source}]{.comments} {.source}[; Gets the bGseXYZ value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns bGseXYZ value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfDistanceFromOptions::getBGseXYZ:source}function SpdfDistanceFromOptions::getBGseXYZ compile_opt idl2 return, self.bGseXYZ end {.source}[;+{.source}]{.comments} {.source}[; Creates an DistanceFromOptions 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}[]{#SpdfDistanceFromOptions::createDomElement:source}function SpdfDistanceFromOptions::createDomElement, $ doc compile_opt idl2 distanceFromOptionsElement = $ doc->createElement('DistanceFromOptions') neutralSheetElement = doc->createElement('NeutralSheet') ovoid = distanceFromOptionsElement->appendChild(neutralSheetElement) if self.neutralSheet eq 1b then begin neutralSheetText = 'true' endif else begin neutralSheetText = 'false' endelse neutralSheetNode = doc->createTextNode(neutralSheetText) ovoid = neutralSheetElement->appendChild(neutralSheetNode) bowShockElement = doc->createElement('BowShock') ovoid = distanceFromOptionsElement->appendChild(bowShockElement) if self.bowShock eq 1b then begin bowShockText = 'true' endif else begin bowShockText = 'false' endelse bowShockNode = doc->createTextNode(bowShockText) ovoid = bowShockElement->appendChild(bowShockNode) mPauseElement = doc->createElement('MPause') ovoid = distanceFromOptionsElement->appendChild(mPauseElement) if self.mPause eq 1b then begin mPauseText = 'true' endif else begin mPauseText = 'false' endelse mPauseNode = doc->createTextNode(mPauseText) ovoid = mPauseElement->appendChild(mPauseNode) bGseXYZElement = doc->createElement('BGseXYZ') ovoid = distanceFromOptionsElement->appendChild(bGseXYZElement) if self.bGseXYZ eq 1b then begin bGseXYZText = 'true' endif else begin bGseXYZText = 'false' endelse bGseXYZNode = doc->createTextNode(bGseXYZText) ovoid = bGseXYZElement->appendChild(bGseXYZNode) return, distanceFromOptionsElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfDistanceFromOptions class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field neutralSheet specifies whether the distance from the neutral{.source}]{.comments} {.source}[; sheet is to be included in the output.{.source}]{.comments} {.source}[; @field bowShock specifies whether the distance from the bow shock{.source}]{.comments} {.source}[; is to be included in the output.{.source}]{.comments} {.source}[; @field mPause specifies whether the distance from the magneto pause{.source}]{.comments} {.source}[; is to be included in the output.{.source}]{.comments} {.source}[; @field bGseXYZ specifies whether the B GSE X, Y, Z values are{.source}]{.comments} {.source}[; to be included in the output.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfDistanceFromOptions__define:source}pro SpdfDistanceFromOptions__define compile_opt idl2 struct = { SpdfDistanceFromOptions, $ neutralSheet:0b, $ bowShock:0b, $ mPause:0b, $ bGseXYZ:0b $ } end {.source}
:::
