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

./

spdffilteredcoordinateoptions__define.pro[]{.file-attributes}

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

Inheritance

SpdfCoordinateOptions :::

Routines

Methods inherited from SpdfCoordinateOptions

Routines from spdffilteredcoordinateoptions__define.pro

[result]{.var} = SpdfFilteredCoordinateOptions::init([coordinateSystem]{.argument}[, component]{.argument}[, filter]{.argument})

: Creates an SpdfFilteredCoordinateOptions object.

SpdfFilteredCoordinateOptions::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfFilteredCoordinateOptions::getFilter()

: Gets the filter value.

[result]{.var} = SpdfFilteredCoordinateOptions::createDomElement([doc]{.argument})

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

SpdfFilteredCoordinateOptions__define

: Defines the SpdfFilteredCoordinateOptions class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfFilteredCoordinateOptions::init([coordinateSystem]{.argument}[, component]{.argument}[, filter]{.argument})

Creates an SpdfFilteredCoordinateOptions object.

Return value

::: small reference to an SpdfFilteredCoordinateOptions object. :::

Parameters

coordinateSystem [in type=string ]{.smaller}

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

component [in type=string ]{.smaller}

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

filter [in type=SpdfLocationFilter ]{.smaller}

: coordinate value filter. :::

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

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

SpdfFilteredCoordinateOptions::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfFilteredCoordinateOptions::getFilter .routine-details .details}

top{.top} source{.top} SpdfFilteredCoordinateOptions::getFilter[]{.routine-attributes}

[result]{.var} = SpdfFilteredCoordinateOptions::getFilter()

Gets the filter value.

Return value

::: small filter value. ::: :::

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

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

[result]{.var} = SpdfFilteredCoordinateOptions::createDomElement([doc]{.argument})

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

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

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

SpdfFilteredCoordinateOptions__define

Defines the SpdfFilteredCoordinateOptions class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::