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

./

spdfobservatorydescription__define.pro[]{.file-attributes}

::: {#file_comments} ::: small This class is an IDL representation of the ObservatoryDescription 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 SpdfObservatoryDescription

Inheritance

SpdfSatelliteDescription :::

Routines

Methods inherited from SpdfSatelliteDescription

Routines from spdfobservatorydescription__define.pro

[result]{.var} = SpdfObservatoryDescription::init([id]{.argument}[, name]{.argument}[, resolution]{.argument}[, startTime]{.argument}[, endTime]{.argument}[, geometry]{.argument}[, trajectoryGeometry]{.argument}[, resourceId]{.argument}[, groupIds]{.argument})

: Creates an SpdfObservatoryDescription object.

SpdfObservatoryDescription::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfObservatoryDescription::getResourceId()

: Gets the resourceId of this satellite.

[result]{.var} = SpdfObservatoryDescription::getGroupIds()

: Gets the groupIds of this satellite.

SpdfObservatoryDescription::print

: Prints a textual representation of this object.

SpdfObservatoryDescription__define

: Defines the SpdfObservatoryDescription class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfObservatoryDescription::init([id]{.argument}[, name]{.argument}[, resolution]{.argument}[, startTime]{.argument}[, endTime]{.argument}[, geometry]{.argument}[, trajectoryGeometry]{.argument}[, resourceId]{.argument}[, groupIds]{.argument})

Creates an SpdfObservatoryDescription object.

Return value

::: small reference to an SpdfObservatoryDescription object. :::

Parameters

id [in type=string ]{.smaller}

: observatory identifier.

name [in type=string ]{.smaller}

: observatory name.

resolution [in type=int ]{.smaller}

: resolution of trajectory information.

startTime [in type=julday ]{.smaller}

: start time of available information.

endTime [in type=julday ]{.smaller}

: end time of available information.

geometry [in type=string ]{.smaller}

: URL of the file containing the recommended X3D geometry description for rendering the satellite.

trajectoryGeometry [in type=string ]{.smaller}

: URL of the file containing the recommended X3D geometry description for rendering the satellite’s trajectory.

resourceId [in type=string ]{.smaller}

: observatory resource identifier.

groupIds [in type=strarr ]{.smaller}

: /Spase/ObservatoryGroupID values. :::

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

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

SpdfObservatoryDescription::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfObservatoryDescription::getResourceId .routine-details .details}

top{.top} source{.top} SpdfObservatoryDescription::getResourceId[]{.routine-attributes}

[result]{.var} = SpdfObservatoryDescription::getResourceId()

Gets the resourceId of this satellite.

Return value

::: small resourceId of this satellite. ::: :::

::: {#SpdfObservatoryDescription::getGroupIds .routine-details .details}

top{.top} source{.top} SpdfObservatoryDescription::getGroupIds[]{.routine-attributes}

[result]{.var} = SpdfObservatoryDescription::getGroupIds()

Gets the groupIds of this satellite.

Return value

::: small groupIds of this satellite. ::: :::

::: {#SpdfObservatoryDescription::print .routine-details .details}

top{.top} source{.top} SpdfObservatoryDescription::print[]{.routine-attributes}

SpdfObservatoryDescription::print

Prints a textual representation of this object.

:::

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

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

SpdfObservatoryDescription__define

Defines the SpdfObservatoryDescription class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::