Package gov.nasa.gsfc.spdf.ssc
Class LocationFilterOptions
- java.lang.Object
-
- gov.nasa.gsfc.spdf.ssc.LocationFilterOptions
-
- All Implemented Interfaces:
java.lang.Cloneable
public class LocationFilterOptions extends java.lang.Object implements java.lang.Cloneable
This class represents additional location filter options. A description of these mapped regions is available at additional location filter help.- Version:
- $Revison: $
- Author:
- B. Harris
-
-
Constructor Summary
Constructors Constructor Description LocationFilterOptions()
Constructs a LocationFilterOptions object with a default value.LocationFilterOptions(boolean allFilters, LocationFilter distanceFromCenterOfEarth, LocationFilter magneticFieldStrength, LocationFilter distanceFromNeutralSheet, LocationFilter distanceFromBowShock, LocationFilter distanceFromMagnetopause, LocationFilter dipoleLValue, LocationFilter dipoleInvariantLatitude)
Constructs a LocationFilterOptions object with the given attribute values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
LocationFilter
getDipoleInvariantLatitude()
Gets the "dipole invariant latitude" filter.LocationFilter
getDipoleLValue()
Gets the "dipole L value" filter.LocationFilter
getDistanceFromBowShock()
Gets the "distance from bow shock" filter.LocationFilter
getDistanceFromCenterOfEarth()
Gets the "distance from center of earth" filter.LocationFilter
getDistanceFromMagnetopause()
Gets the "distance from magnetopause" filter.LocationFilter
getDistanceFromNeutralSheet()
Gets the "distance from neutral sheet" filter.LocationFilter
getMagneticFieldStrength()
Gets the "magnetic field strength" filter.boolean
isAllFilters()
Gets the "all filters" value.void
list(java.io.PrintStream out)
Prints this object's value to the specified output stream.void
setAllFilters(boolean value)
Sets the "all filters" value.void
setDipoleInvariantLatitude(LocationFilter value)
Sets the "dipole invariant latitude" filter.void
setDipoleLValue(LocationFilter value)
Sets the "dipole L value" filter.void
setDistanceFromBowShock(LocationFilter value)
Sets the "distance from bow shock" filter.void
setDistanceFromCenterOfEarth(LocationFilter value)
Sets the "distance from center of earth" filter.void
setDistanceFromMagnetopause(LocationFilter value)
Sets the "distance from magnetopause" filter.void
setDistanceFromNeutralSheet(LocationFilter value)
Sets the "distance from neutral sheet" filter.void
setMagneticFieldStrength(LocationFilter value)
Sets the "magnetic field strength" filter.
-
-
-
Constructor Detail
-
LocationFilterOptions
public LocationFilterOptions()
Constructs a LocationFilterOptions object with a default value.
-
LocationFilterOptions
public LocationFilterOptions(boolean allFilters, LocationFilter distanceFromCenterOfEarth, LocationFilter magneticFieldStrength, LocationFilter distanceFromNeutralSheet, LocationFilter distanceFromBowShock, LocationFilter distanceFromMagnetopause, LocationFilter dipoleLValue, LocationFilter dipoleInvariantLatitude)
Constructs a LocationFilterOptions object with the given attribute values.- Parameters:
allFilters
- specifies whether all or just one or more of the specified filters must be satisfied.distanceFromCenterOfEarth
- specifies the "distance from center of earth" filter.magneticFieldStrength
- specifies the "magnetic field strength" filter.distanceFromNeutralSheet
- specifies the "distance from the neutral sheet" filter.distanceFromBowShock
- specifies the "distance from the bow shock" filter.distanceFromMagnetopause
- specifies the "distance from the magnetopause" filter.dipoleLValue
- specifies the dipoledipoleInvariantLatitude
- specifies the dipole invariant latitude filter
-
-
Method Detail
-
isAllFilters
public boolean isAllFilters()
Gets the "all filters" value.- Returns:
- "all filters" value.
- See Also:
setAllFilters(boolean)
-
setAllFilters
public void setAllFilters(boolean value)
Sets the "all filters" value.- Parameters:
value
- new value- See Also:
isAllFilters()
-
getDistanceFromCenterOfEarth
public LocationFilter getDistanceFromCenterOfEarth()
Gets the "distance from center of earth" filter.- Returns:
- "distance from center of earth" filter.
- See Also:
setDistanceFromCenterOfEarth(gov.nasa.gsfc.spdf.ssc.LocationFilter)
-
setDistanceFromCenterOfEarth
public void setDistanceFromCenterOfEarth(LocationFilter value)
Sets the "distance from center of earth" filter.- Parameters:
value
- new value- See Also:
getDistanceFromCenterOfEarth()
-
getMagneticFieldStrength
public LocationFilter getMagneticFieldStrength()
Gets the "magnetic field strength" filter.- Returns:
- "magnetic field strength" filter.
- See Also:
setMagneticFieldStrength(gov.nasa.gsfc.spdf.ssc.LocationFilter)
-
setMagneticFieldStrength
public void setMagneticFieldStrength(LocationFilter value)
Sets the "magnetic field strength" filter.- Parameters:
value
- new value- See Also:
getMagneticFieldStrength()
-
getDistanceFromNeutralSheet
public LocationFilter getDistanceFromNeutralSheet()
Gets the "distance from neutral sheet" filter.- Returns:
- "distance from neutral sheet" filter.
- See Also:
setDistanceFromNeutralSheet(gov.nasa.gsfc.spdf.ssc.LocationFilter)
-
setDistanceFromNeutralSheet
public void setDistanceFromNeutralSheet(LocationFilter value)
Sets the "distance from neutral sheet" filter.- Parameters:
value
- new value- See Also:
getDistanceFromNeutralSheet()
-
getDistanceFromBowShock
public LocationFilter getDistanceFromBowShock()
Gets the "distance from bow shock" filter.- Returns:
- "distance from bow shock" filter.
- See Also:
setDistanceFromBowShock(gov.nasa.gsfc.spdf.ssc.LocationFilter)
-
setDistanceFromBowShock
public void setDistanceFromBowShock(LocationFilter value)
Sets the "distance from bow shock" filter.- Parameters:
value
- new value- See Also:
getDistanceFromBowShock()
-
getDistanceFromMagnetopause
public LocationFilter getDistanceFromMagnetopause()
Gets the "distance from magnetopause" filter.- Returns:
- "distance from magnetopause" filter.
- See Also:
setDistanceFromMagnetopause(gov.nasa.gsfc.spdf.ssc.LocationFilter)
-
setDistanceFromMagnetopause
public void setDistanceFromMagnetopause(LocationFilter value)
Sets the "distance from magnetopause" filter.- Parameters:
value
- new value- See Also:
getDistanceFromMagnetopause()
-
getDipoleLValue
public LocationFilter getDipoleLValue()
Gets the "dipole L value" filter.- Returns:
- "dipole L value" filter.
- See Also:
setDipoleLValue(gov.nasa.gsfc.spdf.ssc.LocationFilter)
-
setDipoleLValue
public void setDipoleLValue(LocationFilter value)
Sets the "dipole L value" filter.- Parameters:
value
- new value- See Also:
getDipoleLValue()
-
getDipoleInvariantLatitude
public LocationFilter getDipoleInvariantLatitude()
Gets the "dipole invariant latitude" filter.- Returns:
- "dipole invariant latitude" filter.
- See Also:
setDipoleInvariantLatitude(gov.nasa.gsfc.spdf.ssc.LocationFilter)
-
setDipoleInvariantLatitude
public void setDipoleInvariantLatitude(LocationFilter value)
Sets the "dipole invariant latitude" filter.- Parameters:
value
- new value- See Also:
getDipoleInvariantLatitude()
-
list
public void list(java.io.PrintStream out)
Prints this object's value to the specified output stream. This method is useful for debugging.- Parameters:
out
- an output stream
-
clone
public java.lang.Object clone()
- Overrides:
clone
in classjava.lang.Object
-
-