gov.nasa.gsfc.spdf.ssc
Class MappedRegionFilterOptions

java.lang.Object
  gov.nasa.gsfc.spdf.ssc.MappedRegionFilterOptions

public class MappedRegionFilterOptions
extends java.lang.Object

This class represents mapped region filter options. A description of these mapped regions is available at SSC Models and Regions of Geospace.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

MappedRegionFilterOptions()
Constructs a MapptedRegionFilterOptions object with a default value.

MappedRegionFilterOptions(HemisphereOptions cusp, HemisphereOptions cleft, HemisphereOptions auroralOval, HemisphereOptions polarCap, HemisphereOptions midLatitude, boolean lowLatitude)
Constructs a MappedRegionFilterOptions object with the given attribute values.

Method Summary

HemisphereOptions	getAuroralOval() Gets the Auroral Oval hemisphere region listing options.
HemisphereOptions	getCleft() Gets the Cleft hemisphere region listing options.
HemisphereOptions	getCusp() Gets the Cusp hemisphere region listing options.
HemisphereOptions	getMidLatitude() Gets the Mid Latitude hemisphere region listing options.
HemisphereOptions	getPolarCap() Gets the Polar Cap hemisphere region listing options.
boolean	isLowLatitude() Gets the Low Latitude hemisphere region listing options.
void	setAuroralOval(HemisphereOptions value) Sets the Auroral Oval hemisphere region listing options.
void	setCleft(HemisphereOptions value) Sets the Cleft hemisphere region listing options.
void	setCusp(HemisphereOptions value) Sets the Cusp hemisphere region listing options.
void	setLowLatitude(boolean value) Sets the Low Latitude hemisphere region listing options.
void	setMidLatitude(HemisphereOptions value) Sets the Mid Latitude hemisphere region listing options.
void	setPolarCap(HemisphereOptions value) Sets the Polar Cap hemisphere region listing options.

Methods inherited from class java.lang.Object

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

Constructor Detail

MappedRegionFilterOptions

public MappedRegionFilterOptions()

Constructs a MapptedRegionFilterOptions object with a default value.

MappedRegionFilterOptions

public MappedRegionFilterOptions(HemisphereOptions cusp,
                                 HemisphereOptions cleft,
                                 HemisphereOptions auroralOval,
                                 HemisphereOptions polarCap,
                                 HemisphereOptions midLatitude,
                                 boolean lowLatitude)

Constructs a MappedRegionFilterOptions object with the given attribute values.

Parameters:

cusp - Cusp hemisphere listing options

cleft - Cleft hemisphere listing options

auroralOval - Auroral Oval hemisphere listing options

polarCap - Polar Cap hemisphere listing options

midLatitude - Mid Latitude hemisphere listing options

lowLatitude - Low Latitude hemisphere listing options

Method Detail

getCusp

public HemisphereOptions getCusp()

Gets the Cusp hemisphere region listing options.

Returns:

Cusp hemisphere region listing options

See Also:

setCusp(gov.nasa.gsfc.spdf.ssc.HemisphereOptions)

setCusp

public void setCusp(HemisphereOptions value)

Sets the Cusp hemisphere region listing options.

Parameters:

value - new value

See Also:

getCusp()

getCleft

public HemisphereOptions getCleft()

Gets the Cleft hemisphere region listing options.

Returns:

Cleft hemisphere region listing options

See Also:

setCleft(gov.nasa.gsfc.spdf.ssc.HemisphereOptions)

setCleft

public void setCleft(HemisphereOptions value)

Sets the Cleft hemisphere region listing options.

Parameters:

value - new value

See Also:

getCleft()

getAuroralOval

public HemisphereOptions getAuroralOval()

Gets the Auroral Oval hemisphere region listing options.

Returns:

Auroral Oval hemisphere region listing options

See Also:

setAuroralOval(gov.nasa.gsfc.spdf.ssc.HemisphereOptions)

setAuroralOval

public void setAuroralOval(HemisphereOptions value)

Sets the Auroral Oval hemisphere region listing options.

Parameters:

value - new value

See Also:

getAuroralOval()

getPolarCap

public HemisphereOptions getPolarCap()

Gets the Polar Cap hemisphere region listing options.

Returns:

Polar Cap hemisphere region listing options

See Also:

setPolarCap(gov.nasa.gsfc.spdf.ssc.HemisphereOptions)

setPolarCap

public void setPolarCap(HemisphereOptions value)

Sets the Polar Cap hemisphere region listing options.

Parameters:

value - new value

See Also:

getPolarCap()

getMidLatitude

public HemisphereOptions getMidLatitude()

Gets the Mid Latitude hemisphere region listing options.

Returns:

Mid Latitude hemisphere region listing options

See Also:

setMidLatitude(gov.nasa.gsfc.spdf.ssc.HemisphereOptions)

setMidLatitude

public void setMidLatitude(HemisphereOptions value)

Sets the Mid Latitude hemisphere region listing options.

Parameters:

value - new value

See Also:

getMidLatitude()

isLowLatitude

public boolean isLowLatitude()

Gets the Low Latitude hemisphere region listing options.

Returns:

Low Latitude hemisphere region listing options

See Also:

setLowLatitude(boolean)

setLowLatitude

public void setLowLatitude(boolean value)

Sets the Low Latitude hemisphere region listing options.

Parameters:

value - new value

See Also:

isLowLatitude()