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

./

spdfssc__define.pro[]{.file-attributes}

::: {#file_comments} ::: small This class represents the remotely callable interface to NASA’s Space Physics Data Facility (SPDF) Satellite Situation Center (SSC). The current implementation only support the “data locations” functionality. Supporting the “text (listing) locations”, “conjunctions” and/or “graphs” functionality is a future possibility if there were sufficient interest. ::: :::

Author information

Author

: B. Harris

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

Routines from spdfssc__define.pro

[result]{.var} = SpdfSsc::init([ [endpoint=[string]{.var}]]{.argument}[ [, userAgent=[string]{.var}]]{.argument}[ [, sslVerifyPeer=[int]{.var}]]{.argument})

: Creates an object representing SSC.

SpdfSsc::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfSsc::getDefaultEndpoint()

: Gets the default endpoint value.

[result]{.var} = SpdfSsc::getObservatories([ [httpErrorReporter=[SpdfHttpErrorReporter]{.var}]]{.argument})

: Gets a description of all the observatories that are available.

[result]{.var} = SpdfSsc::getGroundStations([ [httpErrorReporter=[SpdfHttpErrorReporter]{.var}]]{.argument})

: Gets a description of all the ground stations that are available.

SpdfSsc__define

: Defines the SpdfSsc class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfSsc::init([ [endpoint=[string]{.var}]]{.argument}[[,userAgent=[string]{.var}]]{.argument}[[,sslVerifyPeer=[int]{.var}]]{.argument})

Creates an object representing SSC.

Return value

::: small a reference to a SSC object. :::

Keywords

endpoint [in optional type=string default=self->getDefaultEndpoint()]{.smaller}

: URL of SSC web service .

userAgent [in optional type=string default=SscWs]{.smaller}

: HTTP user-agent value used in communications with SSC.

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

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

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

SpdfSsc::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfSsc::getDefaultEndpoint .routine-details .details}

top{.top} source{.top} SpdfSsc::getDefaultEndpoint[]{.routine-attributes}

[result]{.var} = SpdfSsc::getDefaultEndpoint()

Gets the default endpoint value.

Return value

::: small default endpoint string value. ::: :::

::: {#SpdfSsc::getObservatories .routine-details .details}

top{.top} source{.top} SpdfSsc::getObservatories[]{.routine-attributes}

[result]{.var} = SpdfSsc::getObservatories([ [httpErrorReporter=[SpdfHttpErrorReporter]{.var}]]{.argument})

Gets a description of all the observatories that are available.

Return value

::: small array of SpdfObservatoryDescription objects. :::

Keywords

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

: used to report an HTTP error. :::

::: {#SpdfSsc::getGroundStations .routine-details .details}

top{.top} source{.top} SpdfSsc::getGroundStations[]{.routine-attributes}

[result]{.var} = SpdfSsc::getGroundStations([ [httpErrorReporter=[SpdfHttpErrorReporter]{.var}]]{.argument})

Gets a description of all the ground stations that are available.

Return value

::: small array of SpdfGroundStation objects. :::

Keywords

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

: used to report an HTTP error. :::

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

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

SpdfSsc__define

Defines the SpdfSsc class.

::: :::

::: {#attributes}

File attributes

Modification date: Tue Jan 16 13:12:32 2024 Lines: 398

:::

SSC Feedback. :::

::: footer

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

:::