::: header

SSC R2.4 Web Services API

Generated by IDLdoc

:::

Overview Directory File Source [attach.png] {align=“top”} Etc Categories Search Index Help User documentation

single page{target=“_top”} | use frames{target=“_top”} summary class fields routine details file attributes

::: content

./

spdflocations__define.pro[]{.file-attributes}

::: {#file_comments} ::: small This class is an IDL representation of the Locations element from the Satellite Situation Center (SSC) XML schema. ::: :::

Author information

Author

: B. Harris

: 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

Class description for SpdfLocations

Inheritance

SpdfCoordinateData

Properties

Properties in SpdfLocations

::: details

latitude [init ]{.smaller}

localTime [init ]{.smaller}

longitude [init ]{.smaller}

x [init ]{.smaller}

y [init ]{.smaller}

z [init ]{.smaller}

:
::: :::

Routines

Methods inherited from SpdfCoordinateData

Routines from spdflocations__define.pro

[result]{.var} = SpdfLocations::init([id]{.argument}[, time]{.argument}[, coordinateSystem]{.argument}[, x=[dblarr]{.var}]{.argument}[, y=[dblarr]{.var}]{.argument}[, z=[dblarr]{.var}]{.argument}[, latitude=[fltarr]{.var}]{.argument}[, longitude=[fltarr]{.var}]{.argument}[, localTime=[dblarr]{.var}]{.argument})

: Creates an SpdfLocations object.

SpdfLocations::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfLocations::getId()

: Gets the id value.

[result]{.var} = SpdfLocations::getTime()

: Gets the time values.

SpdfLocations__define

: Defines the SpdfLocations class.

::: {#routine-details}

Routine details

::: {#SpdfLocations::init .routine-details .details}

top{.top} source{.top} SpdfLocations::init[]{.routine-attributes}

[result]{.var} = SpdfLocations::init([id]{.argument}[, time]{.argument}[, coordinateSystem]{.argument}[, x=[dblarr]{.var}]{.argument}[, y=[dblarr]{.var}]{.argument}[, z=[dblarr]{.var}]{.argument}[, latitude=[fltarr]{.var}]{.argument}[, longitude=[fltarr]{.var}]{.argument}[, localTime=[dblarr]{.var}]{.argument})

Creates an SpdfLocations object.

Return value

::: small reference to an SpdfLocations object. :::

Parameters

id [in type=string ]{.smaller}

: satellite identifier.

time [in type=dblarr ]{.smaller}

: juldate time of location.

coordinateSystem [in type=string ]{.smaller}

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

Keywords

x [in type=dblarr ]{.smaller}

: X values.

y [in type=dblarr ]{.smaller}

: Y values.

z [in type=dblarr ]{.smaller}

: Z values.

latitude [in type=fltarr ]{.smaller}

: latitude values.

longitude [in type=fltarr ]{.smaller}

: longitude values.

localTime [in type=dblarr ]{.smaller}

: local time values. :::

::: {#SpdfLocations::cleanup .routine-details .details}

top{.top} source{.top} SpdfLocations::cleanup[]{.routine-attributes}

SpdfLocations::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfLocations::getId .routine-details .details}

top{.top} source{.top} SpdfLocations::getId[]{.routine-attributes}

[result]{.var} = SpdfLocations::getId()

Gets the id value.

Return value

::: small the id value. ::: :::

::: {#SpdfLocations::getTime .routine-details .details}

top{.top} source{.top} SpdfLocations::getTime[]{.routine-attributes}

[result]{.var} = SpdfLocations::getTime()

Gets the time values.

Return value

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

::: {#SpdfLocations__define .routine-details .details}

top{.top} source{.top} SpdfLocations__define[]{.routine-attributes}

SpdfLocations__define

Defines the SpdfLocations class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

Produced by IDLdoc 3.6.4 on Mon Apr 8 09:51:00 2024 IDLdoc project information{target=“_top”}

:::