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

./

spdfcoordinateoptions__define.pro[]{.file-attributes}

::: {#file_comments} ::: small This class is an IDL representation of the CoordinateOptions element from the Satellite Situation Center (SSC) XML schema. ::: :::

Author information

Author

: B. Harris

: Copyright (c) 2013-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 SpdfCoordinateOptions

Subclasses: SpdfFilteredCoordinateOptions :::

Routines

Routines from spdfcoordinateoptions__define.pro

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

: Creates an SpdfCoordinateOptions object.

SpdfCoordinateOptions::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfCoordinateOptions::getCoordinateSystem()

: Gets the coordinate system value.

[result]{.var} = SpdfCoordinateOptions::getComponent()

: Gets the coordinate component value.

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

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

SpdfCoordinateOptions__define

: Defines the SpdfCoordinateOptions class.

::: {#routine-details}

Routine details

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

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

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

Creates an SpdfCoordinateOptions object.

Return value

::: small reference to an SpdfCoordinateOptions object. :::

Parameters

coordinateSystem [in type=string ]{.smaller}

: specifies the coordinateSystem. Must be one of the following values: Geo, Gm, Gse, 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. :::

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

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

SpdfCoordinateOptions::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfCoordinateOptions::getCoordinateSystem .routine-details .details}

top{.top} source{.top} SpdfCoordinateOptions::getCoordinateSystem[]{.routine-attributes}

[result]{.var} = SpdfCoordinateOptions::getCoordinateSystem()

Gets the coordinate system value.

Return value

::: small coordinate system value. ::: :::

::: {#SpdfCoordinateOptions::getComponent .routine-details .details}

top{.top} source{.top} SpdfCoordinateOptions::getComponent[]{.routine-attributes}

[result]{.var} = SpdfCoordinateOptions::getComponent()

Gets the coordinate component value.

Return value

::: small coordinate component value. ::: :::

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

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

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

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

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

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

SpdfCoordinateOptions__define

Defines the SpdfCoordinateOptions class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::