::: 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 CoordinateData{.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 SpdfCoordinateData object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @param coordinateSystem {in} {type=string}{.source}]{.comments} {.source}[; coordinate system (valid values: "Geo", "Gm", "Gse",{.source}]{.comments} {.source}[; "Gsm", "Sm", "GeiTod", "GeiJ2000").{.source}]{.comments} {.source}[; @keyword x {in} {type=dblarr}{.source}]{.comments} {.source}[; X values.{.source}]{.comments} {.source}[; @keyword y {in} {type=dblarr}{.source}]{.comments} {.source}[; Y values.{.source}]{.comments} {.source}[; @keyword z {in} {type=dblarr}{.source}]{.comments} {.source}[; Z values.{.source}]{.comments} {.source}[; @keyword latitude {in} {type=fltarr}{.source}]{.comments} {.source}[; latitude values.{.source}]{.comments} {.source}[; @keyword longitude {in} {type=fltarr}{.source}]{.comments} {.source}[; longitude values.{.source}]{.comments} {.source}[; @keyword localTime {in} {type=dblarr}{.source}]{.comments} {.source}[; local time values.{.source}]{.comments} {.source}[; @returns reference to an SpdfCoordinateData object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateData::init:source}function SpdfCoordinateData::init, $ coordinateSystem, $ x = x, $ y = y, $ z = z, $ latitude = latitude, $ longitude = longitude, $ localTime = localTime compile_opt idl2 self.coordinateSystem = coordinateSystem if keyword_set(x) then self.x = ptr_new(x) if keyword_set(y) then self.y = ptr_new(y) if keyword_set(z) then self.z = ptr_new(z) if keyword_set(latitude) then self.latitude = ptr_new(latitude) if keyword_set(longitude) then self.longitude = ptr_new(longitude) if keyword_set(localTime) then self.localTime = ptr_new(localTime) return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateData::cleanup:source}pro SpdfCoordinateData::cleanup compile_opt idl2 if ptr_valid(self.x) then ptr_free, self.x if ptr_valid(self.y) then ptr_free, self.x if ptr_valid(self.z) then ptr_free, self.x if ptr_valid(self.latitude) then ptr_free, self.latitude if ptr_valid(self.longitude) then ptr_free, self.longitude if ptr_valid(self.localTime) then ptr_free, self.localTime end {.source}[;+{.source}]{.comments} {.source}[; Gets the coordinate system value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns the coordinate system value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateData::getCoordinateSystem:source}function SpdfCoordinateData::getCoordinateSystem compile_opt idl2 return, self.coordinateSystem end {.source}[;+{.source}]{.comments} {.source}[; Gets the X values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing X values or the constant scalar{.source}]{.comments} {.source}[; !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateData::getX:source}function SpdfCoordinateData::getX compile_opt idl2 if ptr_valid(self.x) then begin return, *self.x endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the Y values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing Y values or the constant scalar{.source}]{.comments} {.source}[; !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateData::getY:source}function SpdfCoordinateData::getY compile_opt idl2 if ptr_valid(self.y) then begin return, *self.y endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the Z values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing Z values or the constant scalar{.source}]{.comments} {.source}[; !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateData::getZ:source}function SpdfCoordinateData::getZ compile_opt idl2 if ptr_valid(self.z) then begin return, *self.z endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the latitude values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a fltarr containing latitude values or the constant scalar{.source}]{.comments} {.source}[; !values.f_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateData::getLatitude:source}function SpdfCoordinateData::getLatitude compile_opt idl2 if ptr_valid(self.latitude) then begin return, *self.latitude endif else begin return, !values.f_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the longitude values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a fltarr containing longitude values or the constant scalar{.source}]{.comments} {.source}[; !values.f_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateData::getLongitude:source}function SpdfCoordinateData::getLongitude compile_opt idl2 if ptr_valid(self.longitude) then begin return, *self.longitude endif else begin return, !values.f_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Gets the local time values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a fltarr containing local time values or the constant scalar{.source}]{.comments} {.source}[; !values.f_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateData::getLocalTime:source}function SpdfCoordinateData::getLocalTime compile_opt idl2 if ptr_valid(self.localTime) then begin return, *self.localTime endif else begin return, !values.f_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfCoordinateData class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field coordinateSystem coordinate system identifier.{.source}]{.comments} {.source}[; @field x X coordinate values.{.source}]{.comments} {.source}[; @field y Y coordinate values.{.source}]{.comments} {.source}[; @field z Z coordinate values.{.source}]{.comments} {.source}[; @field latitude latitude values.{.source}]{.comments} {.source}[; @field longitude longitude values.{.source}]{.comments} {.source}[; @field localTime localTime values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfCoordinateData__define:source}pro SpdfCoordinateData__define compile_opt idl2 struct = { SpdfCoordinateData, $ coordinateSystem:'', $ x:ptr_new(), $ y:ptr_new(), $ z:ptr_new(), $ latitude:ptr_new(), $ longitude:ptr_new(), $ localTime:ptr_new() $ } end {.source} :::