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) 2014 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 LocationFilterOptions{.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}[; Note: SSC's filtering features do not support CDF output so this{.source}]{.comments} {.source}[; class is not required until this IDL library supports requests{.source}]{.comments} {.source}[; for text output.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @copyright Copyright (c) 2014 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 SpdfLocationFilterOptions object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @keyword allFilters {in} {optional} {type=boolean} {.source}]{.comments} {.source}[; {default=true}{.source}]{.comments} {.source}[; specifies whether all or just one or more of the{.source}]{.comments} {.source}[; specified location filters must be satisfied.{.source}]{.comments} {.source}[; @keyword distanceFromCenterOfEarth {in} {optional} {.source}]{.comments} {.source}[; {type=SpdfLocationFilter}{.source}]{.comments} {.source}[; distance from the center of the Earth filter.{.source}]{.comments} {.source}[; @returns reference to an SpdfLocationFilterOptions object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilterOptions::init:source}function SpdfLocationFilterOptions::init, $ allFilters = allFilters, $ distanceFromCenterOfEarth = distanceFromCenterOfEarth, $ magneticFieldStrength = magneticFieldStrength, $ distanceFromNeutralSheet = distanceFromNeutralSheet, $ distanceFromBowShock = distanceFromBowShock, $ distanceFromMagnetopause = distanceFromMagnetopause, $ dipoleLValue = dipoleLValue, $ dipoleInvariantLatitude = dipoleInvariantLatitude compile_opt idl2 if keyword_set(allFilters) then begin self.allFilters = 1b endif else begin self.allFilters = 0b endelse if keyword_set(distanceFromCenterOfEarth) then begin self.distanceFromCenterOfEarth = $ ptr_new(distanceFromCenterOfEarth) endif if keyword_set(magneticFieldStrength) then begin self.magneticFieldStrength = $ ptr_new(magneticFieldStrength) endif if keyword_set(distanceFromNeutralSheet) then begin self.distanceFromNeutralSheet = $ ptr_new(distanceFromNeutralSheet) endif if keyword_set(distanceFromBowShock) then begin self.distanceFromBowShock = $ ptr_new(distanceFromBowShock) endif if keyword_set(distanceFromMagnetopause) then begin self.distanceFromMagnetopause = $ ptr_new(distanceFromMagnetopause) endif if keyword_set(dipoleLValue) then begin self.dipoleLValue = $ ptr_new(dipoleLValue) endif if keyword_set(dipoleInvariantLatitude) then begin self.dipoleInvariantLatitude = $ ptr_new(dipoleInvariantLatitude) endif return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilterOptions::cleanup:source}pro SpdfLocationFilterOptions::cleanup compile_opt idl2 if ptr_valid(self.distanceFromCenterOfEarth) then begin ptr_free, self.distanceFromCenterOfEarth endif if obj_valid(self.magneticFieldStrength) then begin obj_destroy, self.magneticFieldStrength endif if obj_valid(self.distanceFromNeutralSheet) then begin obj_destroy, self.distanceFromNeutralSheet endif if obj_valid(self.distanceFromBowShock) then begin obj_destroy, self.distanceFromBowShock endif if ptr_valid(self.distanceFromMagnetopause) then begin ptr_free, self.distanceFromMagnetopause endif if ptr_valid(self.dipoleLValue) then begin ptr_free, self.dipoleLValue endif if ptr_valid(self.dipoleInvariantLatitude) then begin ptr_free, self.dipoleInvariantLatitude endif end {.source}[;+{.source}]{.comments} {.source}[; Gets the all-filters value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns all-filters value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilterOptions::getAllFilters:source}function SpdfLocationFilterOptions::getAllFilters compile_opt idl2 return, self.allFilters end {.source}[;+{.source}]{.comments} {.source}[; Gets the distance from center of Earth filter value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns distance from center of Earth SpdfLocationFilter or {.source}]{.comments} {.source}[; a null object reference.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilterOptions::getDistanceFromCenterOfEarth:source}function SpdfLocationFilterOptions::getDistanceFromCenterOfEarth compile_opt idl2 if obj_valid(self.distanceFromCenterOfEarth) then begin return, self.distanceFromCenterOfEarth endif else begin return, obj_new() endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the magnetic field strength filter value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns magnetic field strength SpdfLocationFilter or {.source}]{.comments} {.source}[; a null object reference.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilterOptions::getMagneticFieldStrength:source}function SpdfLocationFilterOptions::getMagneticFieldStrength compile_opt idl2 if obj_valid(self.magneticFieldStrength) then begin return, self.magneticFieldStrength endif else begin return, obj_new() endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the distance from neutral sheet filter value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns distance from neutral sheet SpdfLocationFilter or {.source}]{.comments} {.source}[; a null object reference.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilterOptions::getDistanceFromNeutralSheet:source}function SpdfLocationFilterOptions::getDistanceFromNeutralSheet compile_opt idl2 if obj_valid(self.distanceFromNeutralSheet) then begin return, self.distanceFromNeutralSheet endif else begin return, obj_new() endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the distance from bowshock filter value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns distance from bowshock SpdfLocationFilter or {.source}]{.comments} {.source}[; a null object reference.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilterOptions::getDistanceFromBowShock:source}function SpdfLocationFilterOptions::getDistanceFromBowShock compile_opt idl2 if obj_valid(self.distanceFromBowShock) then begin return, self.distanceFromBowShock endif else begin return, obj_new() endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the distance from magnetopause filter value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns distance from magnetopause SpdfLocationFilter or {.source}]{.comments} {.source}[; a null object reference.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilterOptions::getDistanceFromMagnetopause:source}function SpdfLocationFilterOptions::getDistanceFromMagnetopause compile_opt idl2 if obj_valid(self.distanceFromMagnetopause) then begin return, self.distanceFromMagnetopause endif else begin return, obj_new() endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the dipole L value filter value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns dipole L value SpdfLocationFilter or {.source}]{.comments} {.source}[; a null object reference.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilterOptions::getDipoleLValue:source}function SpdfLocationFilterOptions::getDipoleLValue compile_opt idl2 if obj_valid(self.dipoleLValue) then begin return, self.dipoleLValue endif else begin return, obj_new() endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the dipole invariant latitude value filter value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns dipole invariant latitude value SpdfLocationFilter or {.source}]{.comments} {.source}[; a null object reference.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilterOptions::getDipoleInvariantLatitude:source}function SpdfLocationFilterOptions::getDipoleInvariantLatitude compile_opt idl2 if obj_valid(self.dipoleInvariantLatitude) then begin return, self.dipoleInvariantLatitude endif else begin return, obj_new() endelse end {.source}[;+{.source}]{.comments} {.source}[; Creates an LocationFilterOptions 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}[]{#SpdfLocationFilterOptions::createDomElement:source}function SpdfLocationFilterOptions::createDomElement, $ doc compile_opt idl2 locationFilterOptionsElement = $ doc->createElement('LocationFilterOptions') allFiltersElement = doc->createElement('AllFilters') ovoid = outputOptionsElement->appendChild(allFiltersElement) if self.allFilters eq 1b then begin allFiltersText = 'true' endif else begin allFiltersText = 'false' endelse allFilterNode = doc->createTextNode(allFiltersText) ovoid = allLocationFiltersElement->appendChild( $ allFilterNode) if obj_valid(self.distanceFromCenterOfEarth) then begin distanceFromCenterOfEarthElement = $ self.distanceFromCenterOfEarth->createDomElement(doc) ovoid = locationFilterOptionsElement->appendChild( $ distanceFromCenterOfEarthElement) endif if obj_valid(self.magneticFieldStrength) then begin magneticFieldStrengthElement = $ self.magneticFieldStrength->createDomElement(doc) ovoid = locationFilterOptionsElement->appendChild( $ magneticFieldStrengthElement) endif if obj_valid(self.distanceFromNeutralSheet) then begin distanceFromNeutralSheetElement = $ self.distanceFromCenterOfEarth->createDomElement(doc) ovoid = locationFilterOptionsElement->appendChild( $ distanceFromNeutralSheetElement) endif if obj_valid(self.distanceFromBowShock) then begin distanceFromBowShockElement = $ self.distanceFromBowShock->createDomElement(doc) ovoid = locationFilterOptionsElement->appendChild( $ distanceFromBowShockElement) endif if obj_valid(self.distanceFromMagnetopause) then begin distanceFromMagnetopauseElement = $ self.distanceFromMagnetopause->createDomElement(doc) ovoid = locationFilterOptionsElement->appendChild( $ distanceFromMagnetopauseElement) endif if obj_valid(self.dipoleLValue) then begin dipoleLValueElement = $ self.dipoleLValue->createDomElement(doc) ovoid = locationFilterOptionsElement->appendChild( $ dipoleLValueElement) endif if obj_valid(self.dipoleInvariantLatitude) then begin dipoleInvariantLatitudeElement = $ self.dipoleInvariantLatitude->createDomElement(doc) ovoid = locationFilterOptionsElement->appendChild( $ dipoleInvariantLatitudeElement) endif return, locationFilterOptionsElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfLocationFilterOptions class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field allFilters boolean flag indicating whether all {.source}]{.comments} {.source}[; specified location filters must be true.{.source}]{.comments} {.source}[; @field distanceFromCenterOfEarth distance from center of Earth filter.{.source}]{.comments} {.source}[; @field magneticFieldStrength magnetic field strength filter.{.source}]{.comments} {.source}[; @field distanceFromNeutralSheet distance from neutral sheet filter.{.source}]{.comments} {.source}[; @field distanceFromBowShock distance from bowshock filter.{.source}]{.comments} {.source}[; @field distanceFromMagnetopause distance from magnetopause filter.{.source}]{.comments} {.source}[; @field dipoleLValue dipole L value filter.{.source}]{.comments} {.source}[; @field dipoleInvariantLatitude dipole invariant latitude filter.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilterOptions__define:source}pro SpdfLocationFilterOptions__define compile_opt idl2 struct = { SpdfLocationFilterOptions, $ allFilters:1b, $ distanceFromCenterOfEarth:ptr_new(), $ magneticFieldStrength:obj_new(), $ distanceFromNeutralSheet:obj_new(), $ distanceFromBowShock:obj_new(), $ distanceFromMagnetopause:ptr_new(), $ dipoleLValue:ptr_new(), $ dipoleInvariantLatitude:ptr_new() $ } end {.source}
:::
