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-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 {.source}]{.comments} {.source}[; Reserved.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;+{.source}]{.comments} {.source}[; This class is an IDL representation of the CoordinateOptions{.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-2014 United States Government as {.source}]{.comments} {.source}[; represented by the National Aeronautics and Space Administration.{.source}]{.comments} {.source}[; No 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 SpdfCoordinateOptions 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, Gse, Gsm, Sm, GeiTod, or {.source}]{.comments} {.source}[; 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}[; @returns reference to an SpdfCoordinateOptions object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateOptions::init:source}function SpdfCoordinateOptions::init, $ coordinateSystem, $ component compile_opt idl2 case strlowcase(coordinateSystem) of 'geo' : self.coordinateSystem = 'Geo' 'gm' : self.coordinateSystem = 'Gm' 'gse' : self.coordinateSystem = 'Gse' 'gsm' : self.coordinateSystem = 'Gsm' 'sm' : self.coordinateSystem = 'Sm' 'geitod' : self.coordinateSystem = 'GeiTod' 'geij2000' : self.coordinateSystem = 'GeiJ2000' else : self.coordinateSystem = coordinateSystem endcase case strlowcase(component) of 'x' : self.component = 'X' 'y' : self.component = 'Y' 'z' : self.component = 'Z' 'lat' : self.component = 'Lat' 'lon' : self.component = 'Lon' 'local_time' : self.component = 'Local_Time' else : self.component = component endcase return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateOptions::cleanup:source}pro SpdfCoordinateOptions::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}[]{#SpdfCoordinateOptions::getCoordinateSystem:source}function SpdfCoordinateOptions::getCoordinateSystem compile_opt idl2 return, self.coordinateSystem end {.source}[;+{.source}]{.comments} {.source}[; Gets the coordinate component value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns coordinate component value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateOptions::getComponent:source}function SpdfCoordinateOptions::getComponent compile_opt idl2 return, self.component end {.source}[;+{.source}]{.comments} {.source}[; Creates an CoordinateOptions 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}[]{#SpdfCoordinateOptions::createDomElement:source}function SpdfCoordinateOptions::createDomElement, $ doc compile_opt idl2 coordinateOptionsElement = doc->createElement('CoordinateOptions') coordinateSystemElement = doc->createElement('CoordinateSystem') ovoid = coordinateOptionsElement->appendChild( $ coordinateSystemElement) coordinateSystemNode = doc->createTextNode(self.coordinateSystem) ovoid = coordinateSystemElement->appendChild(coordinateSystemNode) componentElement = doc->createElement('Component') ovoid = coordinateOptionsElement->appendChild(componentElement) componentNode = doc->createTextNode(self.component) ovoid = componentElement->appendChild(componentNode) return, coordinateOptionsElement end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfCoordinateOptions class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field coordinateSystem specifies the coordinate system.{.source}]{.comments} {.source}[; @field component specifies the coordinate component.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateOptions__define:source}pro SpdfCoordinateOptions__define compile_opt idl2 struct = { SpdfCoordinateOptions, $ coordinateSystem:'', $ component:'' $ } end {.source}
:::
