![[attach.png]](idldoc-resources/attach.png)
./
spdflocationfilteroptions__define.pro
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
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 for SpdfLocationFilterOptions
Properties
Properties in SpdfLocationFilterOptions
- allFilters init
- dipoleInvariantLatitude init
- dipoleLValue init
- distanceFromBowShock init
- distanceFromCenterOfEarth init
- distanceFromMagnetopause init
- distanceFromNeutralSheet init
- magneticFieldStrength init
Routines
Routines from spdflocationfilteroptions__define.pro
result = SpdfLocationFilterOptions::init( [/allFilters] [, distanceFromCenterOfEarth=SpdfLocationFilter], magneticFieldStrength=magneticFieldStrength, distanceFromNeutralSheet=distanceFromNeutralSheet, distanceFromBowShock=distanceFromBowShock, distanceFromMagnetopause=distanceFromMagnetopause, dipoleLValue=dipoleLValue, dipoleInvariantLatitude=dipoleInvariantLatitude)Creates an SpdfLocationFilterOptions object.
SpdfLocationFilterOptions::cleanupPerforms cleanup operations when this object is destroyed.
result = SpdfLocationFilterOptions::getAllFilters()Gets the all-filters value.
result = SpdfLocationFilterOptions::getDistanceFromCenterOfEarth()Gets the distance from center of Earth filter value.
result = SpdfLocationFilterOptions::getMagneticFieldStrength()Gets the magnetic field strength filter value.
result = SpdfLocationFilterOptions::getDistanceFromNeutralSheet()Gets the distance from neutral sheet filter value.
result = SpdfLocationFilterOptions::getDistanceFromBowShock()Gets the distance from bowshock filter value.
result = SpdfLocationFilterOptions::getDistanceFromMagnetopause()Gets the distance from magnetopause filter value.
result = SpdfLocationFilterOptions::getDipoleLValue()Gets the dipole L value filter value.
result = SpdfLocationFilterOptions::getDipoleInvariantLatitude()Gets the dipole invariant latitude value filter value.
result = SpdfLocationFilterOptions::createDomElement(doc)Creates an LocationFilterOptions element using the given XML DOM document with the values of this object.
SpdfLocationFilterOptions__defineDefines the SpdfLocationFilterOptions class.
Routine details
top source SpdfLocationFilterOptions::init
result = SpdfLocationFilterOptions::init( [/allFilters] [, distanceFromCenterOfEarth=SpdfLocationFilter], magneticFieldStrength=magneticFieldStrength, distanceFromNeutralSheet=distanceFromNeutralSheet, distanceFromBowShock=distanceFromBowShock, distanceFromMagnetopause=distanceFromMagnetopause, dipoleLValue=dipoleLValue, dipoleInvariantLatitude=dipoleInvariantLatitude)
Creates an SpdfLocationFilterOptions object.
Return value
reference to an SpdfLocationFilterOptions object.
Keywords
- allFilters in optional type=boolean default=true
specifies whether all or just one or more of the specified location filters must be satisfied.
- distanceFromCenterOfEarth in optional type=SpdfLocationFilter
distance from the center of the Earth filter.
- magneticFieldStrength
- distanceFromNeutralSheet
- distanceFromBowShock
- distanceFromMagnetopause
- dipoleLValue
- dipoleInvariantLatitude
top source SpdfLocationFilterOptions::cleanup
SpdfLocationFilterOptions::cleanup
Performs cleanup operations when this object is destroyed.
top source SpdfLocationFilterOptions::getAllFilters
result = SpdfLocationFilterOptions::getAllFilters()
Gets the all-filters value.
Return value
all-filters value.
top source SpdfLocationFilterOptions::getDistanceFromCenterOfEarth
result = SpdfLocationFilterOptions::getDistanceFromCenterOfEarth()
Gets the distance from center of Earth filter value.
Return value
distance from center of Earth SpdfLocationFilter or a null object reference.
top source SpdfLocationFilterOptions::getMagneticFieldStrength
result = SpdfLocationFilterOptions::getMagneticFieldStrength()
Gets the magnetic field strength filter value.
Return value
magnetic field strength SpdfLocationFilter or a null object reference.
top source SpdfLocationFilterOptions::getDistanceFromNeutralSheet
result = SpdfLocationFilterOptions::getDistanceFromNeutralSheet()
Gets the distance from neutral sheet filter value.
Return value
distance from neutral sheet SpdfLocationFilter or a null object reference.
top source SpdfLocationFilterOptions::getDistanceFromBowShock
result = SpdfLocationFilterOptions::getDistanceFromBowShock()
Gets the distance from bowshock filter value.
Return value
distance from bowshock SpdfLocationFilter or a null object reference.
top source SpdfLocationFilterOptions::getDistanceFromMagnetopause
result = SpdfLocationFilterOptions::getDistanceFromMagnetopause()
Gets the distance from magnetopause filter value.
Return value
distance from magnetopause SpdfLocationFilter or a null object reference.
top source SpdfLocationFilterOptions::getDipoleLValue
result = SpdfLocationFilterOptions::getDipoleLValue()
Gets the dipole L value filter value.
Return value
dipole L value SpdfLocationFilter or a null object reference.
top source SpdfLocationFilterOptions::getDipoleInvariantLatitude
result = SpdfLocationFilterOptions::getDipoleInvariantLatitude()
Gets the dipole invariant latitude value filter value.
Return value
dipole invariant latitude value SpdfLocationFilter or a null object reference.
top source SpdfLocationFilterOptions::createDomElement
result = SpdfLocationFilterOptions::createDomElement(doc)
Creates an LocationFilterOptions element using the given XML DOM document with the values of this object.
Return value
a reference to a new IDLffXMLDOMElement representation of this object.
Parameters
- doc in type=IDLffXMLDOMDocument
document in which to create the DataRequest element.
File attributes
| Modification date: | Fri May 13 08:54:13 2022 |
| Lines: | 201 |
SSC Feedback.