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

./

spdfsatellitedescription__define.pro[]{.file-attributes}

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

Subclasses: SpdfObservatoryDescription :::

Routines

Routines from spdfsatellitedescription__define.pro

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

: Creates an SpdfSatelliteDescription object.

SpdfSatelliteDescription::cleanup

: Performs cleanup operations when this object is destroyed.

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

: Gets the id of this satellite.

[result]{.var} = SpdfSatelliteDescription::getName()

: Gets the name of this satellite.

[result]{.var} = SpdfSatelliteDescription::getResolution()

: Gets the resolution of this satellite.

[result]{.var} = SpdfSatelliteDescription::getStartTime()

: Gets the start time of this satellite.

[result]{.var} = SpdfSatelliteDescription::getEndTime()

: Gets the end time of this satellite.

[result]{.var} = SpdfSatelliteDescription::getGeometry()

: Gets the geometry of this satellite.

[result]{.var} = SpdfSatelliteDescription::getTrajectoryGeometry()

: Gets the trajectory geometry of this satellite.

SpdfSatelliteDescription::print

: Prints a textual representation of this object.

SpdfSatelliteDescription__define

: Defines the SpdfSatelliteDescription class.

::: {#routine-details}

Routine details

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

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

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

Creates an SpdfSatelliteDescription object.

Return value

::: small reference to an SpdfSatelliteDescription object. :::

Parameters

id [in type=string ]{.smaller}

: satellite identifier.

name [in type=string ]{.smaller}

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

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

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

SpdfSatelliteDescription::cleanup

Performs cleanup operations when this object is destroyed.

:::

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

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

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

Gets the id of this satellite.

Return value

::: small id of this satellite. ::: :::

::: {#SpdfSatelliteDescription::getName .routine-details .details}

top{.top} source{.top} SpdfSatelliteDescription::getName[]{.routine-attributes}

[result]{.var} = SpdfSatelliteDescription::getName()

Gets the name of this satellite.

Return value

::: small name of this satellite. ::: :::

::: {#SpdfSatelliteDescription::getResolution .routine-details .details}

top{.top} source{.top} SpdfSatelliteDescription::getResolution[]{.routine-attributes}

[result]{.var} = SpdfSatelliteDescription::getResolution()

Gets the resolution of this satellite.

Return value

::: small resolution of this satellite. ::: :::

::: {#SpdfSatelliteDescription::getStartTime .routine-details .details}

top{.top} source{.top} SpdfSatelliteDescription::getStartTime[]{.routine-attributes}

[result]{.var} = SpdfSatelliteDescription::getStartTime()

Gets the start time of this satellite.

Return value

::: small start time of this satellite. ::: :::

::: {#SpdfSatelliteDescription::getEndTime .routine-details .details}

top{.top} source{.top} SpdfSatelliteDescription::getEndTime[]{.routine-attributes}

[result]{.var} = SpdfSatelliteDescription::getEndTime()

Gets the end time of this satellite.

Return value

::: small end time of this satellite. ::: :::

::: {#SpdfSatelliteDescription::getGeometry .routine-details .details}

top{.top} source{.top} SpdfSatelliteDescription::getGeometry[]{.routine-attributes}

[result]{.var} = SpdfSatelliteDescription::getGeometry()

Gets the geometry of this satellite.

Return value

::: small geometry of this satellite. ::: :::

::: {#SpdfSatelliteDescription::getTrajectoryGeometry .routine-details .details}

top{.top} source{.top} SpdfSatelliteDescription::getTrajectoryGeometry[]{.routine-attributes}

[result]{.var} = SpdfSatelliteDescription::getTrajectoryGeometry()

Gets the trajectory geometry of this satellite.

Return value

::: small trajectory geometry of this satellite. ::: :::

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

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

SpdfSatelliteDescription::print

Prints a textual representation of this object.

:::

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

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

SpdfSatelliteDescription__define

Defines the SpdfSatelliteDescription class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::