# Complete SSC R2.4.17 Web Services API

## Generated by IDLdoc

single page | use frames summary class fields routine details file attributes

## ./

# spdfobservatorydescription__define.pro

This class is an IDL representation of the ObservatoryDescription element from the Satellite Situation Center (SSC) XML schema.

## Author information

Author

  B. Harris

Copyright

  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 for SpdfObservatoryDescription

### Inheritance

- SpdfSatelliteDescription

### Fields

#### Fields in SpdfSatelliteDescription

- endTime 0.0000000D
- geometry ''
- id ''
- name ''
- resolution 0L
- startTime 0.0000000D
- trajectoryGeometry ''

#### Fields in SpdfObservatoryDescription

GROUPIDS ptr_new()
resourceId ''

  observatory resource identifier.

## Routines

### Methods inherited from SpdfSatelliteDescription

- `SpdfSatelliteDescription::print`
- `result = SpdfSatelliteDescription::getId()`
- `result = SpdfSatelliteDescription::getTrajectoryGeometry()`
- `result = SpdfSatelliteDescription::getEndTime()`
- `result = SpdfSatelliteDescription::getName()`
- `result = SpdfSatelliteDescription::getResolution()`
- `result = SpdfSatelliteDescription::init(id, name, resolution, startTime, endTime, geometry, trajectoryGeometry)`
- `SpdfSatelliteDescription::cleanup`
- `result = SpdfSatelliteDescription::getGeometry()`
- `result = SpdfSatelliteDescription::getStartTime()`

### Routines from spdfobservatorydescription__define.pro

`result = SpdfObservatoryDescription::init(id, name, resolution, startTime, endTime, geometry, trajectoryGeometry, resourceId, groupIds)`

  Creates an SpdfObservatoryDescription object.

`SpdfObservatoryDescription::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfObservatoryDescription::getResourceId()`

  Gets the resourceId of this satellite.

`result = 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

## top source SpdfObservatoryDescription::init

`result = SpdfObservatoryDescription::init(id, name, resolution, startTime, endTime, geometry, trajectoryGeometry, resourceId, groupIds)`

Creates an SpdfObservatoryDescription object.

### Return value

reference to an SpdfObservatoryDescription object.

### Parameters

id in type=string

  observatory identifier.

name in type=string

  observatory name.

resolution in type=int

  resolution of trajectory information.

startTime in type=julday

  start time of available information.

endTime in type=julday

  end time of available information.

geometry in type=string

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

trajectoryGeometry in type=string

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

resourceId in type=string

  observatory resource identifier.

groupIds in type=strarr

  /Spase/ObservatoryGroupID values.

## top source SpdfObservatoryDescription::cleanup

`SpdfObservatoryDescription::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfObservatoryDescription::getResourceId

`result = SpdfObservatoryDescription::getResourceId()`

Gets the resourceId of this satellite.

### Return value

resourceId of this satellite.

## top source SpdfObservatoryDescription::getGroupIds

`result = SpdfObservatoryDescription::getGroupIds()`

Gets the groupIds of this satellite.

### Return value

groupIds of this satellite.

## top source SpdfObservatoryDescription::print

`SpdfObservatoryDescription::print`

Prints a textual representation of this object.

## top source SpdfObservatoryDescription__define

`SpdfObservatoryDescription__define`

Defines the SpdfObservatoryDescription class.

## File attributes

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

SSC Feedback.