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 RegionOptions{.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 SpdfRegionOptions object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @keyword spacecraft {in} {optional} {type=boolean} {default=false}{.source}]{.comments} {.source}[; specifies whether the spacecraft regions are to be{.source}]{.comments} {.source}[; included in the output.{.source}]{.comments} {.source}[; @keyword radialTracedFootpoint {in} {optional} {type=boolean} {.source}]{.comments} {.source}[; {default=false}{.source}]{.comments} {.source}[; specifies whether the radial traced footpoint regions {.source}]{.comments} {.source}[; are to be included in the output.{.source}]{.comments} {.source}[; @keyword northBTracedFootpoint {in} {optional} {type=boolean} {.source}]{.comments} {.source}[; {default=false}{.source}]{.comments} {.source}[; specifies whether the north B traced footpoint regions {.source}]{.comments} {.source}[; are to be included in the output.{.source}]{.comments} {.source}[; @keyword southBTracedFootpoint {in} {optional} {type=boolean} {.source}]{.comments} {.source}[; {default=false}{.source}]{.comments} {.source}[; specifies whether the south B traced footpoint regions {.source}]{.comments} {.source}[; are to be included in the output.{.source}]{.comments} {.source}[; @returns reference to an SpdfRegionOptions object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRegionOptions::init:source}function SpdfRegionOptions::init, $ spacecraft = spacecraft, $ radialTracedFootpoint = radialTracedFootpoint, $ northBTracedFootpoint = northBTracedFootpoint, $ southBTracedFootpoint = southBTracedFootpoint compile_opt idl2 if keyword_set(spacecraft) then begin self.spacecraft = spacecraft endif else begin self.spacecraft = 0b endelse if keyword_set(radialTracedFootpoint) then begin self.radialTracedFootpoint = radialTracedFootpoint endif else begin self.radialTracedFootpoint = 0b endelse if keyword_set(northBTracedFootpoint) then begin self.northBTracedFootpoint = northBTracedFootpoint endif else begin self.northBTracedFootpoint = 0b endelse if keyword_set(southBTracedFootpoint) then begin self.southBTracedFootpoint = southBTracedFootpoint endif else begin self.southBTracedFootpoint = 0b endelse return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRegionOptions::cleanup:source}pro SpdfRegionOptions::cleanup compile_opt idl2 end {.source}[;+{.source}]{.comments} {.source}[; Gets the spacecraft value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns spacecraft value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRegionOptions::getSpacecraft:source}function SpdfRegionOptions::getSpacecraft compile_opt idl2 return, self.spacecraft end {.source}[;+{.source}]{.comments} {.source}[; Gets the radial traced footpoint value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns radial traced footpoint value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRegionOptions::getRadialTracedFootpoint:source}function SpdfRegionOptions::getRadialTracedFootpoint compile_opt idl2 return, self.radialTracedFootpoint end {.source}[;+{.source}]{.comments} {.source}[; Gets the north B traced footpoint value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns north B traced footpoint value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRegionOptions::getNorthBTracedFootpoint:source}function SpdfRegionOptions::getNorthBTracedFootpoint compile_opt idl2 return, self.northBTracedFootpoint end {.source}[;+{.source}]{.comments} {.source}[; Gets the south B traced footpoint value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns south B traced footpoint value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRegionOptions::getSouthBTracedFootpoint:source}function SpdfRegionOptions::getSouthBTracedFootpoint compile_opt idl2 return, self.southBTracedFootpoint end {.source}[;+{.source}]{.comments} {.source}[; Creates an RegionOptions 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}[]{#SpdfRegionOptions::createDomElement:source}function SpdfRegionOptions::createDomElement, $ doc compile_opt idl2 regionOptionsElement = doc->createElement('RegionOptions') spacecraftElement = doc->createElement('Spacecraft') ovoid = regionOptionsElement->appendChild(spacecraftElement) if self.spacecraft eq 1b then begin spacecraftText = 'true' endif else begin spacecraftText = 'false' endelse spacecraftNode = doc->createTextNode(spacecraftText) ovoid = spacecraftElement->appendChild(spacecraftNode) radialTracedFootpointElement = $ doc->createElement('RadialTracedFootpoint') ovoid = $ regionOptionsElement->appendChild(radialTracedFootpointElement) if self.radialTracedFootpoint eq 1b then begin radialTracedFootpointText = 'true' endif else begin radialTracedFootpointText = 'false' endelse radialTracedFootpointNode = $ doc->createTextNode(radialTracedFootpointText) ovoid = radialTracedFootpointElement->appendChild( $ radialTracedFootpointNode) northBTracedFootpointElement = $ doc->createElement('NorthBTracedFootpoint') ovoid = $ regionOptionsElement->appendChild(northBTracedFootpointElement) if self.northBTracedFootpoint eq 1b then begin northBTracedFootpointText = 'true' endif else begin northBTracedFootpointText = 'false' endelse northBTracedFootpointNode = $ doc->createTextNode(northBTracedFootpointText) ovoid = northBTracedFootpointElement->appendChild( $ northBTracedFootpointNode) southBTracedFootpointElement = $ doc->createElement('SouthBTracedFootpoint') ovoid = $ regionOptionsElement->appendChild(southBTracedFootpointElement) if self.southBTracedFootpoint eq 1b then begin southBTracedFootpointText = 'true' endif else begin southBTracedFootpointText = 'false' endelse southBTracedFootpointNode = $ doc->createTextNode(southBTracedFootpointText) ovoid = southBTracedFootpointElement->appendChild( $ southBTracedFootpointNode) return, regionOptionsElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfRegionOptions class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field spacecraft specifies whether the spacecraft regions are to be{.source}]{.comments} {.source}[; included in the output.{.source}]{.comments} {.source}[; @field radialTracedFootpoint specifies whether the radial traced{.source}]{.comments} {.source}[; footpoint regions are to be included in the output.{.source}]{.comments} {.source}[; @field northBTracedFootpoint specifies whether the north B traced{.source}]{.comments} {.source}[; footpoint regions are to be included in the output.{.source}]{.comments} {.source}[; @field southBTracedFootpoint specifies whether the south B traced{.source}]{.comments} {.source}[; footpoint regions are to be included in the output.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfRegionOptions__define:source}pro SpdfRegionOptions__define compile_opt idl2 struct = { SpdfRegionOptions, $ spacecraft:0b, $ radialTracedFootpoint:0b, $ northBTracedFootpoint:0b, $ southBTracedFootpoint:0b $ } end {.source}
:::
