# Complete SSC R2.4.17 Web Services API

## Generated by IDLdoc

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

## ./

# spdfsatellitespecification__define.pro

This class is an IDL representation of the SatelliteSpecification 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 SpdfSatelliteSpecification

### Fields

#### Fields in SpdfSatelliteSpecification

id ''

  satellite identifier.

resolutionFactor 0L

  resolution factor.

## Routines

### Routines from spdfsatellitespecification__define.pro

`result = SpdfSatelliteSpecification::init(id, resolutionFactor)`

  Creates an SpdfSatelliteSpecification object.

`SpdfSatelliteSpecification::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfSatelliteSpecification::getId()`

  Gets the id value.

`result = SpdfSatelliteSpecification::getResolutionFactor()`

  Gets the resolutionFactor value.

`result = SpdfSatelliteSpecification::createDomElement(doc)`

  Creates a SatelliteSpecification element using the given XML DOM document with the values of this object.

`SpdfSatelliteSpecification__define`

  Defines the SpdfSatelliteSpecification class.

## Routine details

## top source SpdfSatelliteSpecification::init

`result = SpdfSatelliteSpecification::init(id, resolutionFactor)`

Creates an SpdfSatelliteSpecification object.

### Return value

reference to an SpdfSatelliteSpecification object.

### Parameters

id in type=string

  satellite identifier.

resolutionFactor in type=int

  resolution factor.

## top source SpdfSatelliteSpecification::cleanup

`SpdfSatelliteSpecification::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfSatelliteSpecification::getId

`result = SpdfSatelliteSpecification::getId()`

Gets the id value.

### Return value

id value.

## top source SpdfSatelliteSpecification::getResolutionFactor

`result = SpdfSatelliteSpecification::getResolutionFactor()`

Gets the resolutionFactor value.

### Return value

resolutionFactor value.

## top source SpdfSatelliteSpecification::createDomElement

`result = SpdfSatelliteSpecification::createDomElement(doc)`

Creates a SatelliteSpecification element using the given XML DOM document with the values of this object.

### Return value

a reference to a new IDLffXMLDOMElement representation of this object.

### Parameters

doc in type=IDLffXMLDOMDocument

  document in which to create the SatelliteSpecification element.

## top source SpdfSatelliteSpecification__define

`SpdfSatelliteSpecification__define`

Defines the SpdfSatelliteSpecification class.

## File attributes

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

SSC Feedback.