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

./

spdfgetlocations.pro[]{.file-attributes}

::: {#file_comments} ::: small This file contains a procedure-oriented wrapper to a subset of functionality from the SpdfSsc class (IDL client interface to Satellite Situation Center Web Services (SSC WSs)) library. ::: :::

Author information

Author

: B. Harris

: Copyright (c) 2013-2021 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.

Routines

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

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

[result]{.var} = SpdfGetLocations([satellite]{.argument}[, timeSpan]{.argument}[[,coordinateSystem=[string]{.var}]]{.argument}[[,resolutionFactor=[int]{.var}]]{.argument}[[,endpoint=[string]{.var}]]{.argument}[ [, /quiet]]{.argument}[[,httpErrorReporter=[SpdfHttpErrorReporter]{.var}]]{.argument}[[,sslVerifyPeer=[int]{.var}]]{.argument})

This function gets basic location information for a single satellite from NASA’s Space Physics Data Facility Satellite Situation Center. More comprehensive information if available by using SpdfSsc::getLocations().

Return value

::: small SpdfLocations object containing requested data. :::

Parameters

satellite [in type=string ]{.smaller}

: identifies the satellite whose location is to be gotten.

timeSpan [in type=strarr(2) ]{.smaller}

: ISO 8601 format strings of the start and stop times of the data to get.

Keywords

coordinateSystem [in optional type=string default=‘Gse’]{.smaller}

: specifies the coordinate system. Must be one of the following values: Geo, Gm, Gsm, Sm, GeiTod, or GeiJ2000.

resolutionFactor [in optional type=int default=1]{.smaller}

: resolution factor. A value of 3 will return every third point.

endpoint [in optional type=string default=‘https://sscweb.gsfc.nasa.gov/WS/sscr/2’]{.smaller}

: URL of SSC web service.

quiet [in optional type=boolean default=false]{.smaller}

: SpdfGetLocations normally prints an error message if no data is found. If QUIET is set, no error messages is printed.

httpErrorReporter [in optional type=SpdfHttpErrorReporter ]{.smaller}

: used to report an HTTP error.

sslVerifyPeer [in optional type=int default=1]{.smaller}

: Specifies whether the authenticity of the peer’s SSL certificate should be verified. When 0, the connection succeeds regardless of what the peer SSL certificate contains.

Examples

     l = spdfGetLocations('ace',
           ['2013-01-01T00:00:00.000Z', '2013-01-03T00:00:00.000Z'])
     p = plot3d(l->getX(), l->getY(), l->getZ(), window_title='Orbit')

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::