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

./

spdflocationfilteroptions__define.pro[]{.file-attributes}

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

Properties

Properties in SpdfLocationFilterOptions

::: details

allFilters [init ]{.smaller}

dipoleInvariantLatitude [init ]{.smaller}

dipoleLValue [init ]{.smaller}

distanceFromBowShock [init ]{.smaller}

distanceFromCenterOfEarth [init ]{.smaller}

distanceFromMagnetopause [init ]{.smaller}

distanceFromNeutralSheet [init ]{.smaller}

magneticFieldStrength [init ]{.smaller}

:
::: :::

Routines

Routines from spdflocationfilteroptions__define.pro

[result]{.var} = SpdfLocationFilterOptions::init([ [/allFilters]]{.argument}[ [, distanceFromCenterOfEarth=[SpdfLocationFilter]{.var}]]{.argument}[, magneticFieldStrength=[magneticFieldStrength]{.var}]{.argument}[, distanceFromNeutralSheet=[distanceFromNeutralSheet]{.var}]{.argument}[, distanceFromBowShock=[distanceFromBowShock]{.var}]{.argument}[, distanceFromMagnetopause=[distanceFromMagnetopause]{.var}]{.argument}[, dipoleLValue=[dipoleLValue]{.var}]{.argument}[, dipoleInvariantLatitude=[dipoleInvariantLatitude]{.var}]{.argument})

: Creates an SpdfLocationFilterOptions object.

SpdfLocationFilterOptions::cleanup

: Performs cleanup operations when this object is destroyed.

[result]{.var} = SpdfLocationFilterOptions::getAllFilters()

: Gets the all-filters value.

[result]{.var} = SpdfLocationFilterOptions::getDistanceFromCenterOfEarth()

: Gets the distance from center of Earth filter value.

[result]{.var} = SpdfLocationFilterOptions::getMagneticFieldStrength()

: Gets the magnetic field strength filter value.

[result]{.var} = SpdfLocationFilterOptions::getDistanceFromNeutralSheet()

: Gets the distance from neutral sheet filter value.

[result]{.var} = SpdfLocationFilterOptions::getDistanceFromBowShock()

: Gets the distance from bowshock filter value.

[result]{.var} = SpdfLocationFilterOptions::getDistanceFromMagnetopause()

: Gets the distance from magnetopause filter value.

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

: Gets the dipole L value filter value.

[result]{.var} = SpdfLocationFilterOptions::getDipoleInvariantLatitude()

: Gets the dipole invariant latitude value filter value.

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

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

SpdfLocationFilterOptions__define

: Defines the SpdfLocationFilterOptions class.

::: {#routine-details}

Routine details

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

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

[result]{.var} = SpdfLocationFilterOptions::init([ [/allFilters]]{.argument}[[,distanceFromCenterOfEarth=[SpdfLocationFilter]{.var}]]{.argument}[, magneticFieldStrength=[magneticFieldStrength]{.var}]{.argument}[, distanceFromNeutralSheet=[distanceFromNeutralSheet]{.var}]{.argument}[, distanceFromBowShock=[distanceFromBowShock]{.var}]{.argument}[, distanceFromMagnetopause=[distanceFromMagnetopause]{.var}]{.argument}[, dipoleLValue=[dipoleLValue]{.var}]{.argument}[, dipoleInvariantLatitude=[dipoleInvariantLatitude]{.var}]{.argument})

Creates an SpdfLocationFilterOptions object.

Return value

::: small reference to an SpdfLocationFilterOptions object. :::

Keywords

allFilters [in optional type=boolean default=true]{.smaller}

: specifies whether all or just one or more of the specified location filters must be satisfied.

distanceFromCenterOfEarth [in optional type=SpdfLocationFilter ]{.smaller}

: distance from the center of the Earth filter.

magneticFieldStrength []{.smaller}

distanceFromNeutralSheet []{.smaller}

distanceFromBowShock []{.smaller}

distanceFromMagnetopause []{.smaller}

dipoleLValue []{.smaller}

dipoleInvariantLatitude []{.smaller}

:
:::

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

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

SpdfLocationFilterOptions::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfLocationFilterOptions::getAllFilters .routine-details .details}

top{.top} source{.top} SpdfLocationFilterOptions::getAllFilters[]{.routine-attributes}

[result]{.var} = SpdfLocationFilterOptions::getAllFilters()

Gets the all-filters value.

Return value

::: small all-filters value. ::: :::

::: {#SpdfLocationFilterOptions::getDistanceFromCenterOfEarth .routine-details .details}

top{.top} source{.top} SpdfLocationFilterOptions::getDistanceFromCenterOfEarth[]{.routine-attributes}

[result]{.var} = SpdfLocationFilterOptions::getDistanceFromCenterOfEarth()

Gets the distance from center of Earth filter value.

Return value

::: small distance from center of Earth SpdfLocationFilter or a null object reference. ::: :::

::: {#SpdfLocationFilterOptions::getMagneticFieldStrength .routine-details .details}

top{.top} source{.top} SpdfLocationFilterOptions::getMagneticFieldStrength[]{.routine-attributes}

[result]{.var} = SpdfLocationFilterOptions::getMagneticFieldStrength()

Gets the magnetic field strength filter value.

Return value

::: small magnetic field strength SpdfLocationFilter or a null object reference. ::: :::

::: {#SpdfLocationFilterOptions::getDistanceFromNeutralSheet .routine-details .details}

top{.top} source{.top} SpdfLocationFilterOptions::getDistanceFromNeutralSheet[]{.routine-attributes}

[result]{.var} = SpdfLocationFilterOptions::getDistanceFromNeutralSheet()

Gets the distance from neutral sheet filter value.

Return value

::: small distance from neutral sheet SpdfLocationFilter or a null object reference. ::: :::

::: {#SpdfLocationFilterOptions::getDistanceFromBowShock .routine-details .details}

top{.top} source{.top} SpdfLocationFilterOptions::getDistanceFromBowShock[]{.routine-attributes}

[result]{.var} = SpdfLocationFilterOptions::getDistanceFromBowShock()

Gets the distance from bowshock filter value.

Return value

::: small distance from bowshock SpdfLocationFilter or a null object reference. ::: :::

::: {#SpdfLocationFilterOptions::getDistanceFromMagnetopause .routine-details .details}

top{.top} source{.top} SpdfLocationFilterOptions::getDistanceFromMagnetopause[]{.routine-attributes}

[result]{.var} = SpdfLocationFilterOptions::getDistanceFromMagnetopause()

Gets the distance from magnetopause filter value.

Return value

::: small distance from magnetopause SpdfLocationFilter or a null object reference. ::: :::

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

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

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

Gets the dipole L value filter value.

Return value

::: small dipole L value SpdfLocationFilter or a null object reference. ::: :::

::: {#SpdfLocationFilterOptions::getDipoleInvariantLatitude .routine-details .details}

top{.top} source{.top} SpdfLocationFilterOptions::getDipoleInvariantLatitude[]{.routine-attributes}

[result]{.var} = SpdfLocationFilterOptions::getDipoleInvariantLatitude()

Gets the dipole invariant latitude value filter value.

Return value

::: small dipole invariant latitude value SpdfLocationFilter or a null object reference. ::: :::

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

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

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

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

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

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

SpdfLocationFilterOptions__define

Defines the SpdfLocationFilterOptions class.

::: :::

::: {#attributes}

File attributes

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

:::

SSC Feedback. :::

::: footer

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

:::