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

./

spdfvalueoptions__define.pro[]{.file-attributes}

::: {#file_comments} ::: small This class is an IDL representation of the ValueOptions 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 SpdfValueOptions

Properties

Properties in SpdfValueOptions

::: details

bFieldStrength [init ]{.smaller}

dipoleInvLat [init ]{.smaller}

dipoleLValue [init ]{.smaller}

radialDistance [init ]{.smaller}

:
::: :::

Routines

Routines from spdfvalueoptions__define.pro

[result]{.var} = SpdfValueOptions::init([ [/radialDistance]]{.argument}[ [, /bFieldStrength]]{.argument}[ [, /dipoleLValue]]{.argument}[ [, /dipoleInvLat]]{.argument})

: Creates an SpdfValueOptions object.

SpdfValueOptions::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfValueOptions::getRadialDistance()

: Gets the radialDistance value.

[result]{.var} = SpdfValueOptions::getBFieldStrength()

: Gets the magnetic field strength value.

[result]{.var} = SpdfValueOptions::getDipoleLValue()

: Gets the dipole L value.

[result]{.var} = SpdfValueOptions::getDipoleInvLat()

: Gets the dipole invariant latitude value.

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

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

SpdfValueOptions__define

: Defines the SpdfValueOptions class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfValueOptions::init([ [/radialDistance]]{.argument}[ [, /bFieldStrength]]{.argument}[ [, /dipoleLValue]]{.argument}[ [, /dipoleInvLat]]{.argument})

Creates an SpdfValueOptions object.

Return value

::: small reference to an SpdfValueOptions object. :::

Keywords

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

: specifies whether the radial distance is to be included in the output.

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

: specifies whether the magnetic field strength is to be included in the output.

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

: specifies whether the dipole L value is to be included in the output.

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

: specifies whether the dipole invariant latitude is to be included in the output. :::

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

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

SpdfValueOptions::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfValueOptions::getRadialDistance .routine-details .details}

top{.top} source{.top} SpdfValueOptions::getRadialDistance[]{.routine-attributes}

[result]{.var} = SpdfValueOptions::getRadialDistance()

Gets the radialDistance value.

Return value

::: small radialDistance value. ::: :::

::: {#SpdfValueOptions::getBFieldStrength .routine-details .details}

top{.top} source{.top} SpdfValueOptions::getBFieldStrength[]{.routine-attributes}

[result]{.var} = SpdfValueOptions::getBFieldStrength()

Gets the magnetic field strength value.

Return value

::: small magnetic field strength value. ::: :::

::: {#SpdfValueOptions::getDipoleLValue .routine-details .details}

top{.top} source{.top} SpdfValueOptions::getDipoleLValue[]{.routine-attributes}

[result]{.var} = SpdfValueOptions::getDipoleLValue()

Gets the dipole L value.

Return value

::: small dipole L value. ::: :::

::: {#SpdfValueOptions::getDipoleInvLat .routine-details .details}

top{.top} source{.top} SpdfValueOptions::getDipoleInvLat[]{.routine-attributes}

[result]{.var} = SpdfValueOptions::getDipoleInvLat()

Gets the dipole invariant latitude value.

Return value

::: small dipole invariant latitude value. ::: :::

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

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

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

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

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

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

SpdfValueOptions__define

Defines the SpdfValueOptions class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::