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 LocationFilter{.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 SpdfLocationFilter object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @keyword minimum {in} {optional} {type=boolean}{.source}]{.comments} {.source}[; specifies that the minimum value that should be{.source}]{.comments} {.source}[; included in the results.{.source}]{.comments} {.source}[; @keyword maximum {in} {optional} {type=boolean}{.source}]{.comments} {.source}[; specifies that the maximum value that should be {.source}]{.comments} {.source}[; included in the results.{.source}]{.comments} {.source}[; @keyword lowerLimit {in} {optional} {type=double}{.source}]{.comments} {.source}[; specifies that the lower limit of values that should {.source}]{.comments} {.source}[; be included in the results.{.source}]{.comments} {.source}[; @keyword upperLimit {in} {optional} {type=double}{.source}]{.comments} {.source}[; specifies that the upper limit of values that should {.source}]{.comments} {.source}[; be included in the results.{.source}]{.comments} {.source}[; @returns reference to an SpdfLocationFilter object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilter::init:source}function SpdfLocationFilter::init, $ minimum = minimum, $ maximum = maximum, $ lowerLimit = lowerLimit, $ upperLimit = upperLimit compile_opt idl2 if keyword_set(minimum) then begin self.minimum = minimum endif else begin self.minimum = 0b endelse if keyword_set(maximum) then begin self.maximum = maximum endif else begin self.maximum = 0b endelse if keyword_set(lowerLimit) then begin self.lowerLimit = lowerLimit endif else begin self.lowerLimit = !values.d_nan endelse if keyword_set(upperLimit) then begin self.upperLimit = upperLimit endif else begin self.upperLimit = !values.d_nan endelse self.spdfTime = obj_new('SpdfTimeInterval', $ '2014-01-01T00:00:00.000Z', $ '2014-01-02T00:00:00.000Z') return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilter::cleanup:source}pro SpdfLocationFilter::cleanup compile_opt idl2 end {.source}[;+{.source}]{.comments} {.source}[; Gets the Minimum value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns Minimum value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilter::getMinimum:source}function SpdfLocationFilter::getMinimum compile_opt idl2 return, self.minimum end {.source}[;+{.source}]{.comments} {.source}[; Gets the Maximum value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns Maximum value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilter::getMaximum:source}function SpdfLocationFilter::getMaximum compile_opt idl2 return, self.maximum end {.source}[;+{.source}]{.comments} {.source}[; Gets the LowerLimit value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns LowerLimit value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilter::getLowerLimit:source}function SpdfLocationFilter::getLowerLimit compile_opt idl2 return, self.lowerLimit end {.source}[;+{.source}]{.comments} {.source}[; Gets the UpperLimit value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns UpperLimit value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilter::getUpperLimit:source}function SpdfLocationFilter::getUpperLimit compile_opt idl2 return, self.upperLimit end {.source}[;+{.source}]{.comments} {.source}[; Creates an LocationFilter 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}[; @param subClassName {in} {type=string}{.source}]{.comments} {.source}[; name of sub-class.{.source}]{.comments} {.source}[; @returns a reference to a new IDLffXMLDOMElement representation of{.source}]{.comments} {.source}[; this object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilter::createDomElement:source}function SpdfLocationFilter::createDomElement, $ doc, $ subClassName compile_opt idl2 locationFilterElement = doc->createElement(subClassName) minElement = doc->createElement('Minimum') ovoid = locationFilterElement->appendChild(minElement) if self.minimum eq 1b then begin minText = 'true' endif else begin minText = 'false' endelse minNode = doc->createTextNode(minText) ovoid = minElement->appendChild(minNode) maxElement = doc->createElement('Maximum') ovoid = locationFilterElement->appendChild(maxElement) if self.maximum eq 1b then begin maxText = 'true' endif else begin maxText = 'false' endelse maxNode = doc->createTextNode(maxText) ovoid = maxElement->appendChild(maxNode) if finite(self.lowerLimit) then begin lowerLimitElement = doc->createElement('LowerLimit') ovoid = locationFilterElement->appendChild(lowerLimitElement) lowerLimitNode = $ doc->createTextNode( $ string(self.lowerLimit, format='(%"%e")')) ovoid = lowerLimitElement->appendChild(lowerLimitNode) endif if finite(self.upperLimit) then begin upperLimitElement = doc->createElement('UpperLimit') ovoid = locationFilterElement->appendChild(upperLimitElement) upperLimitNode = $ doc->createTextNode( $ string(self.upperLimit, format='(%"%e")')) ovoid = upperLimitElement->appendChild(upperLimitNode) endif return, locationFilterElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfLocationFilter class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field minimum specifies that the minimum value should be included {.source}]{.comments} {.source}[; in the results.{.source}]{.comments} {.source}[; @field maximum specifies that the maximum value should be included {.source}]{.comments} {.source}[; in the results.{.source}]{.comments} {.source}[; @field lowerLimit specifies that the lower limit of values that {.source}]{.comments} {.source}[; should be included in the results.{.source}]{.comments} {.source}[; @field upperLimit specifies that the upper limit of values that {.source}]{.comments} {.source}[; should be included in the results.{.source}]{.comments} {.source}[; @field spdfTime constant object used to call "static" methods of{.source}]{.comments} {.source}[; SpdfTimeInterval class.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocationFilter__define:source}pro SpdfLocationFilter__define compile_opt idl2 struct = { SpdfLocationFilter, $ minimum:0b, $ maximum:0b, $ lowerLimit:0d, $ upperLimit:0d, $ spdfTime:obj_new() $ } end {.source}
:::
