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 ValueOptions{.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 SpdfValueOptions object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @keyword radialDistance {in} {optional} {type=boolean} {default=false}{.source}]{.comments} {.source}[; specifies whether the radial distance is to be{.source}]{.comments} {.source}[; included in the output.{.source}]{.comments} {.source}[; @keyword bFieldStrength {in} {optional} {type=boolean} {default=false}{.source}]{.comments} {.source}[; specifies whether the magnetic field strength is to be{.source}]{.comments} {.source}[; included in the output.{.source}]{.comments} {.source}[; @keyword dipoleLValue {in} {optional} {type=boolean} {default=false}{.source}]{.comments} {.source}[; specifies whether the dipole L value is to be included{.source}]{.comments} {.source}[; in the output.{.source}]{.comments} {.source}[; @keyword dipoleInvLat {in} {optional} {type=boolean} {default=false}{.source}]{.comments} {.source}[; specifies whether the dipole invariant latitude is to be{.source}]{.comments} {.source}[; included in the output.{.source}]{.comments} {.source}[; @returns reference to an SpdfValueOptions object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfValueOptions::init:source}function SpdfValueOptions::init, $ radialDistance = radialDistance, $ bFieldStrength = bFieldStrength, $ dipoleLValue = dipoleLValue, $ dipoleInvLat = dipoleInvLat compile_opt idl2 if keyword_set(radialDistance) then begin self.radialDistance = radialDistance endif else begin self.radialDistance = 0b endelse if keyword_set(bFieldStrength) then begin self.bFieldStrength = bFieldStrength endif else begin self.bFieldStrength = 0b endelse if keyword_set(dipoleLValue) then begin self.dipoleLValue = dipoleLValue endif else begin self.dipoleLValue = 0b endelse if keyword_set(dipoleInvLat) then begin self.dipoleInvLat = dipoleInvLat endif else begin self.dipoleInvLat = 0b endelse return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfValueOptions::cleanup:source}pro SpdfValueOptions::cleanup compile_opt idl2 end {.source}[;+{.source}]{.comments} {.source}[; Gets the radialDistance value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns radialDistance value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfValueOptions::getRadialDistance:source}function SpdfValueOptions::getRadialDistance compile_opt idl2 return, self.radialDistance end {.source}[;+{.source}]{.comments} {.source}[; Gets the magnetic field strength value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns magnetic field strength value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfValueOptions::getBFieldStrength:source}function SpdfValueOptions::getBFieldStrength compile_opt idl2 return, self.bFieldStrength end {.source}[;+{.source}]{.comments} {.source}[; Gets the dipole L value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns dipole L value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfValueOptions::getDipoleLValue:source}function SpdfValueOptions::getDipoleLValue compile_opt idl2 return, self.dipoleLValue end {.source}[;+{.source}]{.comments} {.source}[; Gets the dipole invariant latitude value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns dipole invariant latitude value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfValueOptions::getDipoleInvLat:source}function SpdfValueOptions::getDipoleInvLat compile_opt idl2 return, self.dipoleInvLat end {.source}[;+{.source}]{.comments} {.source}[; Creates an ValueOptions element using the given XML DOM document {.source}]{.comments} {.source}[; 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}[]{#SpdfValueOptions::createDomElement:source}function SpdfValueOptions::createDomElement, $ doc compile_opt idl2 valueOptionsElement = doc->createElement('ValueOptions') radialDistanceElement = doc->createElement('RadialDistance') ovoid = valueOptionsElement->appendChild(radialDistanceElement) if self.radialDistance eq 1b then begin radialDistanceText = 'true' endif else begin radialDistanceText = 'false' endelse radialDistanceNode = doc->createTextNode(radialDistanceText) ovoid = radialDistanceElement->appendChild(radialDistanceNode) bFieldStrengthElement = doc->createElement('BFieldStrength') ovoid = valueOptionsElement->appendChild(bFieldStrengthElement) if self.bFieldStrength eq 1b then begin bFieldStrengthText = 'true' endif else begin bFieldStrengthText = 'false' endelse bFieldStrengthNode = doc->createTextNode(bFieldStrengthText) ovoid = bFieldStrengthElement->appendChild(bFieldStrengthNode) dipoleLValueElement = doc->createElement('DipoleLValue') ovoid = valueOptionsElement->appendChild(dipoleLValueElement) if self.dipoleLValue eq 1b then begin dipoleLValueText = 'true' endif else begin dipoleLValueText = 'false' endelse dipoleLValueNode = doc->createTextNode(dipoleLValueText) ovoid = dipoleLValueElement->appendChild(dipoleLValueNode) dipoleInvLatElement = doc->createElement('DipoleInvLat') ovoid = valueOptionsElement->appendChild(dipoleInvLatElement) if self.dipoleInvLat eq 1b then begin dipoleInvLatText = 'true' endif else begin dipoleInvLatText = 'false' endelse dipoleInvLatNode = doc->createTextNode(dipoleInvLatText) ovoid = dipoleInvLatElement->appendChild(dipoleInvLatNode) return, valueOptionsElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfValueOptions class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field radialDistance specifies whether the radial distance is to be{.source}]{.comments} {.source}[; included in the output.{.source}]{.comments} {.source}[; @field bFieldStrength specifies whether the magnetic field strength{.source}]{.comments} {.source}[; is to be included in the output.{.source}]{.comments} {.source}[; @field dipoleLValue specifies whether the dipole L value is to be{.source}]{.comments} {.source}[; included in the output.{.source}]{.comments} {.source}[; @field dipoleInvLat specifies whether the dipole invariant latitude{.source}]{.comments} {.source}[; is to be included in the output.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfValueOptions__define:source}pro SpdfValueOptions__define compile_opt idl2 struct = { SpdfValueOptions, $ radialDistance:0b, $ bFieldStrength:0b, $ dipoleLValue:0b, $ dipoleInvLat:0b $ } end {.source}
:::
