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 Reserved.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[;+{.source}]{.comments} {.source}[; This class is an IDL representation of the Locations{.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 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 SpdfLocations object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @param id {in} {type=string}{.source}]{.comments} {.source}[; satellite identifier.{.source}]{.comments} {.source}[; @param time {in} {type=dblarr}{.source}]{.comments} {.source}[; juldate time of location.{.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 SpdfLocations object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocations::init:source}function SpdfLocations::init, $ id, $ time, $ coordinateSystem, $ x = x, $ y = y, $ z = z, $ latitude = latitude, $ longitude = longitude, $ localTime = localTime compile_opt idl2 if ~(self->SpdfCoordinateData::init( $ coordinateSystem, $ x = x, $ y = y, $ z = z, $ latitude = latitude, $ longitude = longitude, $ localTime = localTime)) then begin return, 0 endif self.id = id self.time = ptr_new(time) return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocations::cleanup:source}pro SpdfLocations::cleanup compile_opt idl2 if ptr_valid(self.time) then ptr_free, self.time {.source}[; self->SpdfCoordinateData::cleanup{.source}]{.comments}end{.source}[;+{.source}]{.comments} {.source}[; Gets the id value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns the id value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocations::getId:source}function SpdfLocations::getId compile_opt idl2 return, self.id end {.source}[;+{.source}]{.comments} {.source}[; Gets the time values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr containing time values or the constant scalar{.source}]{.comments} {.source}[; !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocations::getTime:source}function SpdfLocations::getTime compile_opt idl2 if ptr_valid(self.time) then begin return, *self.time endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfLocations class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field id satellite identifier.{.source}]{.comments} {.source}[; @field time juldate of locations.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfLocations__define:source}pro SpdfLocations__define compile_opt idl2 struct = { SpdfLocations, $ inherits SpdfCoordinateData, $ id:'', $ time:ptr_new() $ } end {.source}
:::
