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 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 BTraceData{.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 SpdfBTraceData object.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @param coordinateSystem {in} {type=string}{.source}]{.comments} {.source}[; coordinate system.{.source}]{.comments} {.source}[; @param hemisphere {in} {type=string}{.source}]{.comments} {.source}[; hemisphere.{.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 arcLength {in} {type=dblarr}{.source}]{.comments} {.source}[; arc length values.{.source}]{.comments} {.source}[; @returns reference to an SpdfBTraceData object.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBTraceData::init:source}function SpdfBTraceData::init, $ coordinateSystem, $ hemisphere, $ latitude = latitude, $ longitude = longitude, $ arcLength = arcLength compile_opt idl2 self.coordinateSystem = coordinateSystem self.hemisphere = hemisphere if keyword_set(latitude) then self.latitude = ptr_new(latitude) if keyword_set(longitude) then self.longitude = ptr_new(longitude) if keyword_set(arcLength) then self.arcLength = ptr_new(arcLength) return, self end {.source}[;+{.source}]{.comments} {.source}[; Performs cleanup operations when this object is destroyed.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBTraceData::cleanup:source}pro SpdfBTraceData::cleanup compile_opt idl2 if ptr_valid(self.latitude) then ptr_free, self.latitude if ptr_valid(self.longitude) then ptr_free, self.longitude if ptr_valid(self.arcLength) then ptr_free, self.arcLength 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}[]{#SpdfBTraceData::getCoordinateSystem:source}function SpdfBTraceData::getCoordinateSystem compile_opt idl2 return, self.coordinateSystem end {.source}[;+{.source}]{.comments} {.source}[; Gets the hemisphere value.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns hemisphere value.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBTraceData::getHemisphere:source}function SpdfBTraceData::getHemisphere compile_opt idl2 return, self.hemisphere end {.source}[;+{.source}]{.comments} {.source}[; Gets the latitude values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a fltarr contain latitude values or the scalar constant{.source}]{.comments} {.source}[; !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBTraceData::getLatitude:source}function SpdfBTraceData::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 contain longitude values or the scalar constant{.source}]{.comments} {.source}[; !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBTraceData::getLongitude:source}function SpdfBTraceData::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 ArcLength values.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @returns a dblarr contain ArcLength values or the scalar constant{.source}]{.comments} {.source}[; !values.d_NaN if there are no values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBTraceData::getArcLength:source}function SpdfBTraceData::getArcLength compile_opt idl2 if ptr_valid(self.arcLength) then begin return, *self.arcLength endif else begin return, !values.d_NaN endelse end {.source}[;+{.source}]{.comments} {.source}[; Defines the SpdfBTraceData class.{.source}]{.comments} {.source}[;{.source}]{.comments} {.source}[; @field coordinateSystem coordinate system.{.source}]{.comments} {.source}[; @field hemisphere hemisphere.{.source}]{.comments} {.source}[; @field latitude latitude values.{.source}]{.comments} {.source}[; @field longitude longitude values.{.source}]{.comments} {.source}[; @field arcLength arc length values.{.source}]{.comments} {.source}[;-{.source}]{.comments} {.source}[]{#SpdfBTraceData__define:source}pro SpdfBTraceData__define compile_opt idl2 struct = { SpdfBTraceData, $ coordinateSystem:'', $ hemisphere:'', $ latitude:ptr_new(), $ longitude:ptr_new(), $ arcLength:ptr_new() $ } end {.source}
:::
