SSC R2.3.15 Web Services API

Generated by IDLdoc

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

./

spdfcoordinatedata__define.pro


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

Author information

Author

B. Harris

Copyright

Copyright (c) 2013 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 SpdfCoordinateData

Subclasses: SpdfLocations

Properties

Properties in SpdfCoordinateData

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

Routines

Routines from spdfcoordinatedata__define.pro

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

Creates an SpdfCoordinateData object.

SpdfCoordinateData::cleanup

Performs cleanup operations when this object is destroyed.

result = SpdfCoordinateData::getCoordinateSystem()

Gets the coordinate system value.

result = SpdfCoordinateData::getX()

Gets the X values.

result = SpdfCoordinateData::getY()

Gets the Y values.

result = SpdfCoordinateData::getZ()

Gets the Z values.

result = SpdfCoordinateData::getLatitude()

Gets the latitude values.

result = SpdfCoordinateData::getLongitude()

Gets the longitude values.

result = SpdfCoordinateData::getLocalTime()

Gets the local time values.

SpdfCoordinateData__define

Defines the SpdfCoordinateData class.

Routine details

top source SpdfCoordinateData::init

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

Creates an SpdfCoordinateData object.

Return value

reference to an SpdfCoordinateData object.

Parameters

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 SpdfCoordinateData::cleanup

SpdfCoordinateData::cleanup

Performs cleanup operations when this object is destroyed.

top source SpdfCoordinateData::getCoordinateSystem

result = SpdfCoordinateData::getCoordinateSystem()

Gets the coordinate system value.

Return value

the coordinate system value.

top source SpdfCoordinateData::getX

result = SpdfCoordinateData::getX()

Gets the X values.

Return value

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

top source SpdfCoordinateData::getY

result = SpdfCoordinateData::getY()

Gets the Y values.

Return value

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

top source SpdfCoordinateData::getZ

result = SpdfCoordinateData::getZ()

Gets the Z values.

Return value

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

top source SpdfCoordinateData::getLatitude

result = SpdfCoordinateData::getLatitude()

Gets the latitude values.

Return value

a fltarr containing latitude values or the constant scalar !values.f_NaN if there are no values.

top source SpdfCoordinateData::getLongitude

result = SpdfCoordinateData::getLongitude()

Gets the longitude values.

Return value

a fltarr containing longitude values or the constant scalar !values.f_NaN if there are no values.

top source SpdfCoordinateData::getLocalTime

result = SpdfCoordinateData::getLocalTime()

Gets the local time values.

Return value

a fltarr containing local time values or the constant scalar !values.f_NaN if there are no values.

top source SpdfCoordinateData__define

SpdfCoordinateData__define

Defines the SpdfCoordinateData class.

File attributes

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


SSC Feedback.