# SSC R2.4.17 Web Services API

## Generated by IDLdoc

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

## ./

# spdflocationfilter__define.pro

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

### Properties

#### Properties in SpdfLocationFilter

lowerLimit init
maximum init
minimum init
upperLimit init

## Routines

### Routines from spdflocationfilter__define.pro

`result = SpdfLocationFilter::init( [/minimum] [, /maximum] [, lowerLimit=double] [, upperLimit=double])`

  Creates an SpdfLocationFilter object.

`SpdfLocationFilter::cleanup`

  Performs cleanup operations when this object is destroyed.

`result = SpdfLocationFilter::getMinimum()`

  Gets the Minimum value.

`result = SpdfLocationFilter::getMaximum()`

  Gets the Maximum value.

`result = SpdfLocationFilter::getLowerLimit()`

  Gets the LowerLimit value.

`result = SpdfLocationFilter::getUpperLimit()`

  Gets the UpperLimit value.

`result = SpdfLocationFilter::createDomElement(doc, subClassName)`

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

`SpdfLocationFilter__define`

  Defines the SpdfLocationFilter class.

## Routine details

## top source SpdfLocationFilter::init

`result = SpdfLocationFilter::init( [/minimum] [, /maximum] [, lowerLimit=double] [, upperLimit=double])`

Creates an SpdfLocationFilter object.

### Return value

reference to an SpdfLocationFilter object.

### Keywords

minimum in optional type=boolean

  specifies that the minimum value that should be included in the results.

maximum in optional type=boolean

  specifies that the maximum value that should be included in the results.

lowerLimit in optional type=double

  specifies that the lower limit of values that should be included in the results.

upperLimit in optional type=double

  specifies that the upper limit of values that should be included in the results.

## top source SpdfLocationFilter::cleanup

`SpdfLocationFilter::cleanup`

Performs cleanup operations when this object is destroyed.

## top source SpdfLocationFilter::getMinimum

`result = SpdfLocationFilter::getMinimum()`

Gets the Minimum value.

### Return value

Minimum value.

## top source SpdfLocationFilter::getMaximum

`result = SpdfLocationFilter::getMaximum()`

Gets the Maximum value.

### Return value

Maximum value.

## top source SpdfLocationFilter::getLowerLimit

`result = SpdfLocationFilter::getLowerLimit()`

Gets the LowerLimit value.

### Return value

LowerLimit value.

## top source SpdfLocationFilter::getUpperLimit

`result = SpdfLocationFilter::getUpperLimit()`

Gets the UpperLimit value.

### Return value

UpperLimit value.

## top source SpdfLocationFilter::createDomElement

`result = SpdfLocationFilter::createDomElement(doc, subClassName)`

Creates an LocationFilter 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.

subClassName in type=string

  name of sub-class.

## top source SpdfLocationFilter__define

`SpdfLocationFilter__define`

Defines the SpdfLocationFilter class.

## File attributes

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

SSC Feedback.