SSC R2.4 Web Services API

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

./

spdflocations__define.pro


This class is an IDL representation of the Locations element from the Satellite Situation Center (SSC) XML schema.

Author information

Author

B. Harris

Copyright

Copyright (c) 2013-2014 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.

Class description for SpdfLocations

Inheritance

Properties

Properties in SpdfLocations

latitude init
localTime init
longitude init
x init
y init
z init

Routines

Methods inherited from SpdfCoordinateData

Routines from spdflocations__define.pro

result = SpdfLocations::init(id, time, coordinateSystem, x=dblarr, y=dblarr, z=dblarr, latitude=fltarr, longitude=fltarr, localTime=dblarr)

Creates an SpdfLocations object.

SpdfLocations::cleanup

Performs cleanup operations when this object is destroyed.

result = SpdfLocations::getId()

Gets the id value.

result = SpdfLocations::getTime()

Gets the time values.

SpdfLocations__define

Defines the SpdfLocations class.

Routine details

top source SpdfLocations::init

result = SpdfLocations::init(id, time, coordinateSystem, x=dblarr, y=dblarr, z=dblarr, latitude=fltarr, longitude=fltarr, localTime=dblarr)

Creates an SpdfLocations object.

Return value

reference to an SpdfLocations object.

Parameters

id in type=string

satellite identifier.

time in type=dblarr

juldate time of location.

coordinateSystem in type=string

coordinate system (valid values: "Geo", "Gm", "Gse", "Gsm", "Sm", "GeiTod", "GeiJ2000").

Keywords

x in type=dblarr

X values.

y in type=dblarr

Y values.

z in type=dblarr

Z values.

latitude in type=fltarr

latitude values.

longitude in type=fltarr

longitude values.

localTime in type=dblarr

local time values.

top source SpdfLocations::cleanup

SpdfLocations::cleanup

Performs cleanup operations when this object is destroyed.

top source SpdfLocations::getId

result = SpdfLocations::getId()

Gets the id value.

Return value

the id value.

top source SpdfLocations::getTime

result = SpdfLocations::getTime()

Gets the time values.

Return value

a dblarr containing time values or the constant scalar !values.d_NaN if there are no values.

top source SpdfLocations__define

SpdfLocations__define

Defines the SpdfLocations class.

File attributes

Modification date: Fri May 13 08:54:13 2022
Lines: 49


SSC Feedback.