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 FilteredCoordinateOptions{.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 SpdfFilteredCoordinateOptions object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @param coordinateSystem {in} {type=string} {.source}]{.comments} {.source}[; specifies the coordinateSystem. Must be one of the{.source}]{.comments} {.source}[; following values: Geo, Gm, Gsm, Sm, GeiTod, or GeiJ2000.{.source}]{.comments} {.source}[; @param component {in} {type=string}{.source}]{.comments} {.source}[; specifies the coordinate component. Must be one of the{.source}]{.comments} {.source}[; following values: X, Y, Z, Lat, Lon, or Local_Time.{.source}]{.comments} {.source}[; @param filter {in} {type=SpdfLocationFilter}{.source}]{.comments} {.source}[; coordinate value filter.{.source}]{.comments} {.source}[; @returns reference to an SpdfFilteredCoordinateOptions object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfFilteredCoordinateOptions::init:source}function SpdfFilteredCoordinateOptions::init, $ coordinateSystem, $ component, $ filter compile_opt idl2 if ~(self->SpdfCoordinateOptions::init( $ coordinateSystem, component)) then begin return, 0 endif self.filter = filter return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfFilteredCoordinateOptions::cleanup:source}pro SpdfFilteredCoordinateOptions::cleanup compile_opt idl2 if obj_valid(self.filter) then obj_destroy, self.filter {.source}[; self->SpdfCoordinateOptions::cleanup{.source}]{.comments}end{.source}[;+{.source}]{.comments} {.source}[; Gets the filter value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns filter value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfFilteredCoordinateOptions::getFilter:source}function SpdfFilteredCoordinateOptions::getFilter compile_opt idl2 if obj_valid(self.filter) then begin return, self.filter endif else begin return, obj_new() endelse end {.source}[;+{.source}]{.comments} {.source}[; Creates an FilteredCoordinateOptions 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}[]{#SpdfFilteredCoordinateOptions::createDomElement:source}function SpdfFilteredCoordinateOptions::createDomElement, $ doc compile_opt idl2 filteredCoordinateOptionsElement = $ self->SpdfCoordinateOptions::createDomElement(doc) if obj_valid(self.filter) then begin filterElement = self.filter->createDomElement(doc, 'Filter') ovoid = filteredCoordinateOptionsElement->appendChild( $ filterElement) endif return, filteredCoordinateOptionsElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfFilteredCoordinateOptions class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field filter specifies filter criteria.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfFilteredCoordinateOptions__define:source}pro SpdfFilteredCoordinateOptions__define compile_opt idl2 struct = { SpdfFilteredCoordinateOptions, $ inherits SpdfCoordinateOptions, $ filter:obj_new() $ } end {.source}
:::
