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

./

spdfcoordinatedata__define.pro[]{.file-attributes}

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

Author information

Author

: B. Harris

: 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

Class description for SpdfCoordinateData

Subclasses: SpdfLocations

Properties

Properties in SpdfCoordinateData

::: details

latitude [init ]{.smaller}

localTime [init ]{.smaller}

longitude [init ]{.smaller}

x [init ]{.smaller}

y [init ]{.smaller}

z [init ]{.smaller}

:
::: :::

Routines

Routines from spdfcoordinatedata__define.pro

[result]{.var} = SpdfCoordinateData::init([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 SpdfCoordinateData object.

SpdfCoordinateData::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfCoordinateData::getCoordinateSystem()

: Gets the coordinate system value.

[result]{.var} = SpdfCoordinateData::getX()

: Gets the X values.

[result]{.var} = SpdfCoordinateData::getY()

: Gets the Y values.

[result]{.var} = SpdfCoordinateData::getZ()

: Gets the Z values.

[result]{.var} = SpdfCoordinateData::getLatitude()

: Gets the latitude values.

[result]{.var} = SpdfCoordinateData::getLongitude()

: Gets the longitude values.

[result]{.var} = SpdfCoordinateData::getLocalTime()

: Gets the local time values.

SpdfCoordinateData__define

: Defines the SpdfCoordinateData class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfCoordinateData::init([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 SpdfCoordinateData object.

Return value

::: small reference to an SpdfCoordinateData object. :::

Parameters

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. :::

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

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

SpdfCoordinateData::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfCoordinateData::getCoordinateSystem .routine-details .details}

top{.top} source{.top} SpdfCoordinateData::getCoordinateSystem[]{.routine-attributes}

[result]{.var} = SpdfCoordinateData::getCoordinateSystem()

Gets the coordinate system value.

Return value

::: small the coordinate system value. ::: :::

::: {#SpdfCoordinateData::getX .routine-details .details}

top{.top} source{.top} SpdfCoordinateData::getX[]{.routine-attributes}

[result]{.var} = SpdfCoordinateData::getX()

Gets the X values.

Return value

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

::: {#SpdfCoordinateData::getY .routine-details .details}

top{.top} source{.top} SpdfCoordinateData::getY[]{.routine-attributes}

[result]{.var} = SpdfCoordinateData::getY()

Gets the Y values.

Return value

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

::: {#SpdfCoordinateData::getZ .routine-details .details}

top{.top} source{.top} SpdfCoordinateData::getZ[]{.routine-attributes}

[result]{.var} = SpdfCoordinateData::getZ()

Gets the Z values.

Return value

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

::: {#SpdfCoordinateData::getLatitude .routine-details .details}

top{.top} source{.top} SpdfCoordinateData::getLatitude[]{.routine-attributes}

[result]{.var} = SpdfCoordinateData::getLatitude()

Gets the latitude values.

Return value

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

::: {#SpdfCoordinateData::getLongitude .routine-details .details}

top{.top} source{.top} SpdfCoordinateData::getLongitude[]{.routine-attributes}

[result]{.var} = SpdfCoordinateData::getLongitude()

Gets the longitude values.

Return value

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

::: {#SpdfCoordinateData::getLocalTime .routine-details .details}

top{.top} source{.top} SpdfCoordinateData::getLocalTime[]{.routine-attributes}

[result]{.var} = SpdfCoordinateData::getLocalTime()

Gets the local time values.

Return value

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

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

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

SpdfCoordinateData__define

Defines the SpdfCoordinateData class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::