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

./

spdfdistancefromoptions__define.pro[]{.file-attributes}

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

Author information

Author

: B. Harris

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

Properties

Properties in SpdfDistanceFromOptions

::: details

bGseXYZ [init ]{.smaller}

bowShock [init ]{.smaller}

mPause [init ]{.smaller}

neutralSheet [init ]{.smaller}

:
::: :::

Routines

Routines from spdfdistancefromoptions__define.pro

[result]{.var} = SpdfDistanceFromOptions::init([ [/neutralSheet]]{.argument}[ [, /bowShock]]{.argument}[ [, /mPause]]{.argument}[ [, /bGseXYZ]]{.argument})

: Creates an SpdfDistanceFromOptions object.

SpdfDistanceFromOptions::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfDistanceFromOptions::getNeutralSheet()

: Gets the distance from the neutral sheet value.

[result]{.var} = SpdfDistanceFromOptions::getBowShock()

: Gets the distance from the bow shock value.

[result]{.var} = SpdfDistanceFromOptions::getMPause()

: Gets the distance from the magneto pause value.

[result]{.var} = SpdfDistanceFromOptions::getBGseXYZ()

: Gets the bGseXYZ value.

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

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

SpdfDistanceFromOptions__define

: Defines the SpdfDistanceFromOptions class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfDistanceFromOptions::init([ [/neutralSheet]]{.argument}[ [, /bowShock]]{.argument}[ [, /mPause]]{.argument}[ [, /bGseXYZ]]{.argument})

Creates an SpdfDistanceFromOptions object.

Return value

::: small reference to an SpdfDistanceFromOptions object. :::

Keywords

neutralSheet [in optional type=boolean default=false]{.smaller}

: specifies whether the distance from the neutral sheet is to be included in the output.

bowShock [in optional type=boolean default=false]{.smaller}

: specifies whether the distance from the bow shock is to be included in the output.

mPause [in optional type=boolean default=false]{.smaller}

: specifies whether the distance from the magneto pause is to be included in the output.

bGseXYZ [in optional type=boolean default=false]{.smaller}

: specifies whether the B GSE X, Y, Z values is to be included in the output. :::

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

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

SpdfDistanceFromOptions::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfDistanceFromOptions::getNeutralSheet .routine-details .details}

top{.top} source{.top} SpdfDistanceFromOptions::getNeutralSheet[]{.routine-attributes}

[result]{.var} = SpdfDistanceFromOptions::getNeutralSheet()

Gets the distance from the neutral sheet value.

Return value

::: small distance from the neutral sheet value. ::: :::

::: {#SpdfDistanceFromOptions::getBowShock .routine-details .details}

top{.top} source{.top} SpdfDistanceFromOptions::getBowShock[]{.routine-attributes}

[result]{.var} = SpdfDistanceFromOptions::getBowShock()

Gets the distance from the bow shock value.

Return value

::: small distance from the bow shock value. ::: :::

::: {#SpdfDistanceFromOptions::getMPause .routine-details .details}

top{.top} source{.top} SpdfDistanceFromOptions::getMPause[]{.routine-attributes}

[result]{.var} = SpdfDistanceFromOptions::getMPause()

Gets the distance from the magneto pause value.

Return value

::: small distance from the magneto pause value. ::: :::

::: {#SpdfDistanceFromOptions::getBGseXYZ .routine-details .details}

top{.top} source{.top} SpdfDistanceFromOptions::getBGseXYZ[]{.routine-attributes}

[result]{.var} = SpdfDistanceFromOptions::getBGseXYZ()

Gets the bGseXYZ value.

Return value

::: small bGseXYZ value. ::: :::

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

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

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

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

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

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

SpdfDistanceFromOptions__define

Defines the SpdfDistanceFromOptions class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::