# Complete SSC R2.4.17 Web Services API

## Generated by IDLdoc

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

## ./

# spdffilteredcoordinateoptions__define.pro

This class is an IDL representation of the FilteredCoordinateOptions element from the Satellite Situation Center (SSC) XML schema. Note: SSC's filtering features do not support CDF output so this class is not required until this IDL library supports requests for text output.

## Author information

Author

  B. Harris

Copyright

  Copyright (c) 2014 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 SpdfFilteredCoordinateOptions

### Inheritance

- SpdfCoordinateOptions

### Fields

#### Fields in SpdfCoordinateOptions

- component ''
- coordinateSystem ''

#### Fields in SpdfFilteredCoordinateOptions

filter obj_new()

  specifies filter criteria.

## Routines

### Methods inherited from SpdfCoordinateOptions

- `result = SpdfCoordinateOptions::getComponent()`
- `result = SpdfCoordinateOptions::init(coordinateSystem, component)`
- `result = SpdfCoordinateOptions::createDomElement(doc)`
- `SpdfCoordinateOptions::cleanup`
- `result = SpdfCoordinateOptions::getCoordinateSystem()`

### Routines from spdffilteredcoordinateoptions__define.pro

`result = SpdfFilteredCoordinateOptions::init(coordinateSystem, component, filter)`

  Creates an SpdfFilteredCoordinateOptions object.

`SpdfFilteredCoordinateOptions::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfFilteredCoordinateOptions::getFilter()`

  Gets the filter value.

`result = SpdfFilteredCoordinateOptions::createDomElement(doc)`

  Creates an FilteredCoordinateOptions element using the given XML DOM document with the values of this object.

`SpdfFilteredCoordinateOptions__define`

  Defines the SpdfFilteredCoordinateOptions class.

## Routine details

## top source SpdfFilteredCoordinateOptions::init

`result = SpdfFilteredCoordinateOptions::init(coordinateSystem, component, filter)`

Creates an SpdfFilteredCoordinateOptions object.

### Return value

reference to an SpdfFilteredCoordinateOptions object.

### Parameters

coordinateSystem in type=string

  specifies the coordinateSystem. Must be one of the following values: Geo, Gm, Gsm, Sm, GeiTod, or GeiJ2000.

component in type=string

  specifies the coordinate component. Must be one of the following values: X, Y, Z, Lat, Lon, or Local_Time.

filter in type=SpdfLocationFilter

  coordinate value filter.

## top source SpdfFilteredCoordinateOptions::cleanup

`SpdfFilteredCoordinateOptions::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfFilteredCoordinateOptions::getFilter

`result = SpdfFilteredCoordinateOptions::getFilter()`

Gets the filter value.

### Return value

filter value.

## top source SpdfFilteredCoordinateOptions::createDomElement

`result = SpdfFilteredCoordinateOptions::createDomElement(doc)`

Creates an FilteredCoordinateOptions 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 DataRequest element.

## top source SpdfFilteredCoordinateOptions__define

`SpdfFilteredCoordinateOptions__define`

Defines the SpdfFilteredCoordinateOptions class.

## File attributes

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

SSC Feedback.