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 BFieldTraceOptions{.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 SpdfBFieldTraceOptions object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @keyword coordinateSystem {in} {optional} {type=string} {.source}]{.comments} {.source}[; {default='Gse'}{.source}]{.comments} {.source}[; specifies the coordinate system is to be included in {.source}]{.comments} {.source}[; the output.{.source}]{.comments} {.source}[; @keyword hemisphere {in} {optional} {type=string} {default='North'}{.source}]{.comments} {.source}[; specifies the hemisphere to be included in the output.{.source}]{.comments} {.source}[; @keyword footpointLatitude {in} {optional} {type=boolean} {.source}]{.comments} {.source}[; {default=false}{.source}]{.comments} {.source}[; specifies whether the footpoint latitude value is to {.source}]{.comments} {.source}[; be included in the output.{.source}]{.comments} {.source}[; @keyword footpointLongitude {in} {optional} {type=boolean} {.source}]{.comments} {.source}[; {default=false}{.source}]{.comments} {.source}[; specifies whether the footpoint longitude value is to {.source}]{.comments} {.source}[; be included in the output.{.source}]{.comments} {.source}[; @keyword fieldLineLength {in} {optional} {type=boolean} {.source}]{.comments} {.source}[; {default=false}{.source}]{.comments} {.source}[; specifies whether the field line length value is to be {.source}]{.comments} {.source}[; included in the output.{.source}]{.comments} {.source}[; @returns reference to an SpdfBFieldTraceOptions object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBFieldTraceOptions::init:source}function SpdfBFieldTraceOptions::init, $ coordinateSystem = coordinateSystem, $ hemisphere = hemisphere, $ footpointLatitude = footpointLatitude, $ footpointLongitude = footpointLongitude, $ fieldLineLength = fieldLineLength compile_opt idl2 if keyword_set(coordinateSystem) then begin self.coordinateSystem = coordinateSystem endif else begin self.coordinateSystem = 'Gse' endelse if keyword_set(hemisphere) then begin self.hemisphere = hemisphere endif else begin self.hemisphere = 'North' endelse if keyword_set(footpointLatitude) then begin self.footpointLatitude = footpointLatitude endif else begin self.footpointLatitude = 0b endelse if keyword_set(footpointLongitude) then begin self.footpointLongitude = footpointLongitude endif else begin self.footpointLongitude = 0b endelse if keyword_set(fieldLineLength) then begin self.fieldLineLength = fieldLineLength endif else begin self.fieldLineLength = 0b endelse return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBFieldTraceOptions::cleanup:source}pro SpdfBFieldTraceOptions::cleanup compile_opt idl2 end {.source}[;+{.source}]{.comments} {.source}[; Gets the coordinate system value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns coordinate system value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBFieldTraceOptions::getCoordinateSystem:source}function SpdfBFieldTraceOptions::getCoordinateSystem compile_opt idl2 return, self.coordinateSystem end {.source}[;+{.source}]{.comments} {.source}[; Gets the hemisphere value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns hemisphere value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBFieldTraceOptions::getHemisphere:source}function SpdfBFieldTraceOptions::getHemisphere compile_opt idl2 return, self.hemisphere end {.source}[;+{.source}]{.comments} {.source}[; Gets the footpoint latitude value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns footpoint latitude value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBFieldTraceOptions::getFootpointLatitude:source}function SpdfBFieldTraceOptions::getFootpointLatitude compile_opt idl2 return, self.footpointLatitude end {.source}[;+{.source}]{.comments} {.source}[; Gets the footpoint longitude value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns footpoint longitude value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBFieldTraceOptions::getFootpointLongitude:source}function SpdfBFieldTraceOptions::getFootpointLongitude compile_opt idl2 return, self.footpointLongitude end {.source}[;+{.source}]{.comments} {.source}[; Gets the field-line length value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns field-line length value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBFieldTraceOptions::getFieldLineLength:source}function SpdfBFieldTraceOptions::getFieldLineLength compile_opt idl2 return, self.fieldLineLength end {.source}[;+{.source}]{.comments} {.source}[; Creates an BFieldTraceOptions 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}[]{#SpdfBFieldTraceOptions::createDomElement:source}function SpdfBFieldTraceOptions::createDomElement, $ doc compile_opt idl2 bFieldTraceOptionsElement = doc->createElement('BFieldTraceOptions') coordinateSystemElement = doc->createElement('CoordinateSystem') ovoid = $ bFieldTraceOptionsElement->appendChild(coordinateSystemElement) coordinateSystemNode = doc->createTextNode(self.coordinateSystem) ovoid = coordinateSystemElement->appendChild(coordinateSystemNode) hemisphereElement = doc->createElement('Hemisphere') ovoid = bFieldTraceOptionsElement->appendChild(hemisphereElement) hemisphereNode = doc->createTextNode(self.hemisphere) ovoid = hemisphereElement->appendChild(hemisphereNode) footpointLatitudeElement = doc->createElement('FootpointLatitude') ovoid = $ bFieldTraceOptionsElement->appendChild(footpointLatitudeElement) if self.footpointLatitude eq 1b then begin footpointLatitudeText = 'true' endif else begin footpointLatitudeText = 'false' endelse footpointLatitudeNode = doc->createTextNode(footpointLatitudeText) ovoid = footpointLatitudeElement->appendChild(footpointLatitudeNode) footpointLongitudeElement = doc->createElement('FootpointLongitude') ovoid = $ bFieldTraceOptionsElement->appendChild( $ footpointLongitudeElement) if self.footpointLongitude eq 1b then begin footpointLongitudeText = 'true' endif else begin footpointLongitudeText = 'false' endelse footpointLongitudeNode = doc->createTextNode(footpointLongitudeText) ovoid = $ footpointLongitudeElement->appendChild(footpointLongitudeNode) fieldLineLengthElement = doc->createElement('FieldLineLength') ovoid = $ bFieldTraceOptionsElement->appendChild(fieldLineLengthElement) if self.fieldLineLength eq 1b then begin fieldLineLengthText = 'true' endif else begin fieldLineLengthText = 'false' endelse fieldLineLengthNode = doc->createTextNode(fieldLineLengthText) ovoid = $ fieldLineLengthElement->appendChild(fieldLineLengthNode) return, bFieldTraceOptionsElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfBFieldTraceOptions class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field coordinateSystem specifies whether the coordinate system is {.source}]{.comments} {.source}[; to be included in the output.{.source}]{.comments} {.source}[; @field hemisphere specifies whether the hemisphere to be included{.source}]{.comments} {.source}[; in the output.{.source}]{.comments} {.source}[; @field footpointLatitude specifies whether the footpoint latitude{.source}]{.comments} {.source}[; value is to be included in the output.{.source}]{.comments} {.source}[; @field footpointLongitude specifies whether the footpoint longitude{.source}]{.comments} {.source}[; value is to be included in the output.{.source}]{.comments} {.source}[; @field fieldLineLength specifies whether the field line length {.source}]{.comments} {.source}[; value is to be included in the output.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBFieldTraceOptions__define:source}pro SpdfBFieldTraceOptions__define compile_opt idl2 struct = { SpdfBFieldTraceOptions, $ coordinateSystem:'', $ hemisphere:'', $ footpointLatitude:0b, $ footpointLongitude:0b, $ fieldLineLength:0b $ } end {.source}
:::
