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

./

spdflocationfilter__define.pro[]{.file-attributes}

::: {#file_comments} ::: small 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 (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

Class description for SpdfLocationFilter

Properties

Properties in SpdfLocationFilter

::: details

lowerLimit [init ]{.smaller}

maximum [init ]{.smaller}

minimum [init ]{.smaller}

upperLimit [init ]{.smaller}

:
::: :::

Routines

Routines from spdflocationfilter__define.pro

[result]{.var} = SpdfLocationFilter::init([ [/minimum]]{.argument}[ [, /maximum]]{.argument}[ [, lowerLimit=[double]{.var}]]{.argument}[ [, upperLimit=[double]{.var}]]{.argument})

: Creates an SpdfLocationFilter object.

SpdfLocationFilter::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfLocationFilter::getMinimum()

: Gets the Minimum value.

[result]{.var} = SpdfLocationFilter::getMaximum()

: Gets the Maximum value.

[result]{.var} = SpdfLocationFilter::getLowerLimit()

: Gets the LowerLimit value.

[result]{.var} = SpdfLocationFilter::getUpperLimit()

: Gets the UpperLimit value.

[result]{.var} = SpdfLocationFilter::createDomElement([doc]{.argument}[, subClassName]{.argument})

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

SpdfLocationFilter__define

: Defines the SpdfLocationFilter class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfLocationFilter::init([ [/minimum]]{.argument}[ [, /maximum]]{.argument}[[,lowerLimit=[double]{.var}]]{.argument}[[,upperLimit=[double]{.var}]]{.argument})

Creates an SpdfLocationFilter object.

Return value

::: small reference to an SpdfLocationFilter object. :::

Keywords

minimum [in optional type=boolean ]{.smaller}

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

maximum [in optional type=boolean ]{.smaller}

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

lowerLimit [in optional type=double ]{.smaller}

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

upperLimit [in optional type=double ]{.smaller}

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

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

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

SpdfLocationFilter::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfLocationFilter::getMinimum .routine-details .details}

top{.top} source{.top} SpdfLocationFilter::getMinimum[]{.routine-attributes}

[result]{.var} = SpdfLocationFilter::getMinimum()

Gets the Minimum value.

Return value

::: small Minimum value. ::: :::

::: {#SpdfLocationFilter::getMaximum .routine-details .details}

top{.top} source{.top} SpdfLocationFilter::getMaximum[]{.routine-attributes}

[result]{.var} = SpdfLocationFilter::getMaximum()

Gets the Maximum value.

Return value

::: small Maximum value. ::: :::

::: {#SpdfLocationFilter::getLowerLimit .routine-details .details}

top{.top} source{.top} SpdfLocationFilter::getLowerLimit[]{.routine-attributes}

[result]{.var} = SpdfLocationFilter::getLowerLimit()

Gets the LowerLimit value.

Return value

::: small LowerLimit value. ::: :::

::: {#SpdfLocationFilter::getUpperLimit .routine-details .details}

top{.top} source{.top} SpdfLocationFilter::getUpperLimit[]{.routine-attributes}

[result]{.var} = SpdfLocationFilter::getUpperLimit()

Gets the UpperLimit value.

Return value

::: small UpperLimit value. ::: :::

::: {#SpdfLocationFilter::createDomElement .routine-details .details}

top{.top} source{.top} SpdfLocationFilter::createDomElement[]{.routine-attributes}

[result]{.var} = SpdfLocationFilter::createDomElement([doc]{.argument}[, subClassName]{.argument})

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

Return value

::: small a reference to a new IDLffXMLDOMElement representation of this object. :::

Parameters

doc [in type=IDLffXMLDOMDocument ]{.smaller}

: document in which to create the DataRequest element.

subClassName [in type=string ]{.smaller}

: name of sub-class. :::

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

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

SpdfLocationFilter__define

Defines the SpdfLocationFilter class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::