Package gov.nasa.gsfc.spdf.ssc

Class RegionFilterOptions

java.lang.Object

gov.nasa.gsfc.spdf.ssc.RegionFilterOptions

public class RegionFilterOptions
extends java.lang.Object

This class represents region filter options. A description of these values is available at the Region Filter help.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

Constructor	Description
RegionFilterOptions()	Constructs a RegionFilterOptions object with a default value.
RegionFilterOptions(SpaceRegionsFilterOptions spaceRegions, MappedRegionFilterOptions radialTraceRegions, MappedRegionFilterOptions magneticTraceRegions)	Constructs a RegionFilterOptions object with the given attribute values.

Method Summary

Modifier and Type	Method	Description
MappedRegionFilterOptions	getMagneticTraceRegions()	Gets the magnetic trace regions filtering options.
MappedRegionFilterOptions	getRadialTraceRegions()	Gets the radial trace regions filtering options.
SpaceRegionsFilterOptions	getSpaceRegions()	Gets the space regions filtering options.
void	list(java.io.PrintStream out)	Prints this object's value to the specified output stream.
void	setMagneticTraceRegions(MappedRegionFilterOptions value)	Sets the magnetic trace regions filtering options.
void	setRadialTraceRegions(MappedRegionFilterOptions value)	Sets the radial trace regions filtering options.
void	setSpaceRegions(SpaceRegionsFilterOptions value)	Sets the space regions filtering options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegionFilterOptions

public RegionFilterOptions()

Constructs a RegionFilterOptions object with a default value.

RegionFilterOptions

public RegionFilterOptions(SpaceRegionsFilterOptions spaceRegions,
                           MappedRegionFilterOptions radialTraceRegions,
                           MappedRegionFilterOptions magneticTraceRegions)

Constructs a RegionFilterOptions object with the given attribute values.

Parameters:

spaceRegions - space region filter options

radialTraceRegions - radial trace region filter options

magneticTraceRegions - magnetic trace region filter options

Method Detail

getSpaceRegions

public SpaceRegionsFilterOptions getSpaceRegions()

Gets the space regions filtering options.

Returns:

space regions filtering options.

See Also:

setSpaceRegions(gov.nasa.gsfc.spdf.ssc.SpaceRegionsFilterOptions)

setSpaceRegions

public void setSpaceRegions(SpaceRegionsFilterOptions value)

Sets the space regions filtering options.

Parameters:

value - new value

See Also:

getSpaceRegions()

getRadialTraceRegions

public MappedRegionFilterOptions getRadialTraceRegions()

Gets the radial trace regions filtering options.

Returns:

radial trace regions filtering options.

See Also:

setRadialTraceRegions(gov.nasa.gsfc.spdf.ssc.MappedRegionFilterOptions)

setRadialTraceRegions

public void setRadialTraceRegions(MappedRegionFilterOptions value)

Sets the radial trace regions filtering options.

Parameters:

value - new value

See Also:

getRadialTraceRegions()

getMagneticTraceRegions

public MappedRegionFilterOptions getMagneticTraceRegions()

Gets the magnetic trace regions filtering options.

Returns:

magnetic trace regions filtering options.

See Also:

setMagneticTraceRegions(gov.nasa.gsfc.spdf.ssc.MappedRegionFilterOptions)

setMagneticTraceRegions

public void setMagneticTraceRegions(MappedRegionFilterOptions value)

Sets the magnetic trace regions filtering options.

Parameters:

value - new value

See Also:

getMagneticTraceRegions()

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