gov.nasa.gsfc.spdf.ssc
Class SpaceRegionsFilterOptions

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

All Implemented Interfaces:

java.lang.Cloneable

public class SpaceRegionsFilterOptions
extends java.lang.Object
implements java.lang.Cloneable

This class represents space regions filter options. A description of these values is available atthe Region Filter help.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

SpaceRegionsFilterOptions()
Constructs a SpaceRegionsFilterOptions object with a default value.

SpaceRegionsFilterOptions(boolean interplanetaryMedium, boolean daysideMagnetosheath, boolean nightsideMagnetosheath, boolean daysideMagnetosphere, boolean nightsideMagnetosphere, boolean plasmaSheet, boolean tailLobe, boolean highLatitudeBoundaryLayer, boolean lowLatitudeBoundaryLayer, boolean daysidePlasmasphere, boolean nightsidePlasmasphere)
Constructs a SpaceRegionsFilterOptions object with the given attribute values.

Method Summary

java.lang.Object	clone()
boolean	isDaysideMagnetosheath() Gets the value indicating whether the dayside magnetosheath region filter is to be applied.
boolean	isDaysideMagnetosphere() Gets the value indicating whether the dayside magnetosphere region filter is to be applied.
boolean	isDaysidePlasmasphere() Gets the value indicating whether the dayside plasmasphere region filter is to be applied.
boolean	isHighLatitudeBoundaryLayer() Gets the value indicating whether the high latitude boundary layer region filter is to be applied.
boolean	isInterplanetaryMedium() Gets the value indicating whether the interplanetary medium region filter is to be applied.
boolean	isLowLatitudeBoundaryLayer() Gets the value indicating whether the low latitude boundary layer region filter is to be applied.
boolean	isNightsideMagnetosheath() Gets the value indicating whether the nightside magnetosheath region filter is to be applied.
boolean	isNightsideMagnetosphere() Gets the value indicating whether the nightside magnetosphere region filter is to be applied.
boolean	isNightsidePlasmasphere() Gets the value indicating whether the nightside plasmasphere region filter is to be applied.
boolean	isPlasmaSheet() Gets the value indicating whether the plamsa sheet region filter is to be applied.
boolean	isTailLobe() Gets the value indicating whether the tail lobe region filter is to be applied.
void	setDaysideMagnetosheath(boolean value) Sets the value indicating whether the dayside magnetosheath region filter is to be applied.
void	setDaysideMagnetosphere(boolean value) Sets the value indicating whether the dayside magnetosphere region filter is to be applied.
void	setDaysidePlasmasphere(boolean value) Sets the value indicating whether the dayside plasmasphere region filter is to be applied.
void	setHighLatitudeBoundaryLayer(boolean value) Sets the value indicating whether the high latitude boundary layer region filter is to be applied.
void	setInterplanetaryMedium(boolean value) Sets the value indicating whether the interplanetary medium region filter is to be applied.
void	setLowLatitudeBoundaryLayer(boolean value) Sets the value indicating whether the low latitude boundary layer region filter is to be applied.
void	setNightsideMagnetosheath(boolean value) Sets the value indicating whether the nightside magnetosheath region filter is to be applied.
void	setNightsideMagnetosphere(boolean value) Sets the value indicating whether the nightside magnetosphere region filter is to be applied.
void	setNightsidePlasmasphere(boolean value) Sets the value indicating whether the nightside plasmasphere region filter is to be applied.
void	setPlasmaSheet(boolean value) Sets the value indicating whether the plasma sheet region filter is to be applied.
void	setTailLobe(boolean value) Sets the value indicating whether the tail lobe region filter is to be applied.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpaceRegionsFilterOptions

public SpaceRegionsFilterOptions()

Constructs a SpaceRegionsFilterOptions object with a default value.

SpaceRegionsFilterOptions

public SpaceRegionsFilterOptions(boolean interplanetaryMedium,
                                 boolean daysideMagnetosheath,
                                 boolean nightsideMagnetosheath,
                                 boolean daysideMagnetosphere,
                                 boolean nightsideMagnetosphere,
                                 boolean plasmaSheet,
                                 boolean tailLobe,
                                 boolean highLatitudeBoundaryLayer,
                                 boolean lowLatitudeBoundaryLayer,
                                 boolean daysidePlasmasphere,
                                 boolean nightsidePlasmasphere)

Constructs a SpaceRegionsFilterOptions object with the given attribute values.

Parameters:

interplanetaryMedium - specifies whether the interplanetary medium region filter is to be applied

daysideMagnetosheath - specifies whether the dayside magnetosheath region filter is to be applied

nightsideMagnetosheath - specifies whether the nightside magnetosheath region filter is to be applied

daysideMagnetosphere - specifies whether the dayside magnetosphere region filter is to be applied

nightsideMagnetosphere - specifies whether the nightside magnetosphere region filter is to be applied

plasmaSheet - specifies whether the plasma sheet region filter is to be applied

tailLobe - specifies whether the tail lobe region filter is to be applied

highLatitudeBoundaryLayer - specifies whether the high latitude boundary layer region filter is to be applied

lowLatitudeBoundaryLayer - specifies whether the low latitude boundary layer region filter is to be applied

daysidePlasmasphere - specifies whether the dayside plasmasphere region filter is to be applied

nightsidePlasmasphere - specifies whether the nightside plasmasphere region filter is to be applied

Method Detail

isInterplanetaryMedium

public boolean isInterplanetaryMedium()

Gets the value indicating whether the interplanetary medium region filter is to be applied.

Returns:

true if the interplanetary medium region filter is to be applied, false if not

See Also:

setInterplanetaryMedium(boolean)

setInterplanetaryMedium

public void setInterplanetaryMedium(boolean value)

Sets the value indicating whether the interplanetary medium region filter is to be applied.

Parameters:

value - new value

See Also:

isInterplanetaryMedium()

isDaysideMagnetosheath

public boolean isDaysideMagnetosheath()

Gets the value indicating whether the dayside magnetosheath region filter is to be applied.

Returns:

true if the dayside magnetosheath region filter is to be applied, false if not

See Also:

setDaysideMagnetosheath(boolean)

setDaysideMagnetosheath

public void setDaysideMagnetosheath(boolean value)

Sets the value indicating whether the dayside magnetosheath region filter is to be applied.

Parameters:

value - new value

See Also:

isDaysideMagnetosheath()

isNightsideMagnetosheath

public boolean isNightsideMagnetosheath()

Gets the value indicating whether the nightside magnetosheath region filter is to be applied.

Returns:

true if the nightside magnetosheath region filter is to be applied, false if not

See Also:

setNightsideMagnetosheath(boolean)

setNightsideMagnetosheath

public void setNightsideMagnetosheath(boolean value)

Sets the value indicating whether the nightside magnetosheath region filter is to be applied.

Parameters:

value - new value

See Also:

isNightsideMagnetosheath()

isDaysideMagnetosphere

public boolean isDaysideMagnetosphere()

Gets the value indicating whether the dayside magnetosphere region filter is to be applied.

Returns:

true if the dayside magnetosphere region filter is to be applied, false if not

See Also:

setDaysideMagnetosphere(boolean)

setDaysideMagnetosphere

public void setDaysideMagnetosphere(boolean value)

Sets the value indicating whether the dayside magnetosphere region filter is to be applied.

Parameters:

value - new value

See Also:

isDaysideMagnetosphere()

isNightsideMagnetosphere

public boolean isNightsideMagnetosphere()

Gets the value indicating whether the nightside magnetosphere region filter is to be applied.

Returns:

true if the nightside magnetosphere region filter is to be applied, false if not

See Also:

setNightsideMagnetosphere(boolean)

setNightsideMagnetosphere

public void setNightsideMagnetosphere(boolean value)

Sets the value indicating whether the nightside magnetosphere region filter is to be applied.

Parameters:

value - new value

See Also:

isNightsideMagnetosphere()

isPlasmaSheet

public boolean isPlasmaSheet()

Gets the value indicating whether the plamsa sheet region filter is to be applied.

Returns:

true if the dayside plasma sheet region filter is to be applied, false if not

See Also:

setPlasmaSheet(boolean)

setPlasmaSheet

public void setPlasmaSheet(boolean value)

Sets the value indicating whether the plasma sheet region filter is to be applied.

Parameters:

value - new value

See Also:

isPlasmaSheet()

isTailLobe

public boolean isTailLobe()

Gets the value indicating whether the tail lobe region filter is to be applied.

Returns:

true if the tail lobe region filter is to be applied, false if not

See Also:

setTailLobe(boolean)

setTailLobe

public void setTailLobe(boolean value)

Sets the value indicating whether the tail lobe region filter is to be applied.

Parameters:

value - new value

See Also:

isTailLobe()

isHighLatitudeBoundaryLayer

public boolean isHighLatitudeBoundaryLayer()

Gets the value indicating whether the high latitude boundary layer region filter is to be applied.

Returns:

true if the high latitude boundary layer region filter is to be applied, false if not

See Also:

setHighLatitudeBoundaryLayer(boolean)

setHighLatitudeBoundaryLayer

public void setHighLatitudeBoundaryLayer(boolean value)

Sets the value indicating whether the high latitude boundary layer region filter is to be applied.

Parameters:

value - new value

See Also:

isHighLatitudeBoundaryLayer()

isLowLatitudeBoundaryLayer

public boolean isLowLatitudeBoundaryLayer()

Gets the value indicating whether the low latitude boundary layer region filter is to be applied.

Returns:

true if the low latitude boundary layer region filter is to be applied, false if not

See Also:

setLowLatitudeBoundaryLayer(boolean)

setLowLatitudeBoundaryLayer

public void setLowLatitudeBoundaryLayer(boolean value)

Sets the value indicating whether the low latitude boundary layer region filter is to be applied.

Parameters:

value - new value

See Also:

isLowLatitudeBoundaryLayer()

isDaysidePlasmasphere

public boolean isDaysidePlasmasphere()

Gets the value indicating whether the dayside plasmasphere region filter is to be applied.

Returns:

true if the dayside plasmasphere region filter is to be applied, false if not

See Also:

setDaysidePlasmasphere(boolean)

setDaysidePlasmasphere

public void setDaysidePlasmasphere(boolean value)

Sets the value indicating whether the dayside plasmasphere region filter is to be applied.

Parameters:

value - new value

See Also:

isDaysidePlasmasphere()

isNightsidePlasmasphere

public boolean isNightsidePlasmasphere()

Gets the value indicating whether the nightside plasmasphere region filter is to be applied.

Returns:

true if the nightside plasmasphere region filter is to be applied, false if not

See Also:

setNightsidePlasmasphere(boolean)

setNightsidePlasmasphere

public void setNightsidePlasmasphere(boolean value)

Sets the value indicating whether the nightside plasmasphere region filter is to be applied.

Parameters:

value - new value

See Also:

isNightsidePlasmasphere()

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object