gov.nasa.gsfc.spdf.ssc
Class RegionOptions

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

All Implemented Interfaces:

java.lang.Cloneable

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

This class represents listing options for regions. "Regions" denotes a naming convention of three dimensional and two dimensional zones that are associated with a spacecraft's location for a particular point in time. The RegionOptions provides a means to specify the type(s) of regions that can be generated as output. All four region types can be associated with a spacecraft at any given time. A description of these regions is available at the Satellite Situation Center help.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

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

RegionOptions(boolean spacecraft, boolean radialTracedFootpoint, boolean northBTracedFootpoint, boolean southBTracedFootpoint)
Constructs a RegionOptions object with the given attribute values.

Method Summary

java.lang.Object	clone()
boolean	isNorthBTracedFootpoint() Gets the value indicating whether the north B traced footpoint regions are to be included in the listing.
boolean	isRadialTracedFootpoint() Gets the value indicating whether the radial traced footpoint regions are to be included in the listing.
boolean	isSouthBTracedFootpoint() Gets the value indicating whether the south B traced footpoint regions are to be included in the listing.
boolean	isSpacecraft() Gets the value indicating whether the spacecraft regions are to be included in the listing.
void	setNorthBTracedFootpoint(boolean value) Sets the value indicating whether the north B traced footpoint regions are to be included in the listing.
void	setRadialTracedFootpoint(boolean value) Sets the value indicating whether the radial traced footpoint regions are to be included in the listing.
void	setSouthBTracedFootpoint(boolean value) Sets the value indicating whether the south B traced footpoint regions are to be included in the listing.
void	setSpacecraft(boolean value) Sets the value indicating whether the spacecraft regions are to be included in the listing.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionOptions

public RegionOptions()

Constructs a RegionOptions object with a default value.

RegionOptions

public RegionOptions(boolean spacecraft,
                     boolean radialTracedFootpoint,
                     boolean northBTracedFootpoint,
                     boolean southBTracedFootpoint)

Constructs a RegionOptions object with the given attribute values.

Parameters:

spacecraft - specifies whether the spacecraft regions are to be included in the listing

radialTracedFootpoint - specifies whether the radial traced footpoint regions are to be included in the listing

northBTracedFootpoint - specifies whether the north B footpoint regions are to be included in the listing

southBTracedFootpoint - specifies whether the south B footpoint regions are to be included in the listing

Method Detail

isSpacecraft

public boolean isSpacecraft()

Gets the value indicating whether the spacecraft regions are to be included in the listing.

Returns:

true if the spacecraft regions are to be output, false if not

See Also:

setSpacecraft(boolean)

setSpacecraft

public void setSpacecraft(boolean value)

Sets the value indicating whether the spacecraft regions are to be included in the listing.

Parameters:

value - new value

See Also:

isSpacecraft()

isRadialTracedFootpoint

public boolean isRadialTracedFootpoint()

Gets the value indicating whether the radial traced footpoint regions are to be included in the listing.

Returns:

true if the radial traced footpoint regions are to be output, false if not

See Also:

setRadialTracedFootpoint(boolean)

setRadialTracedFootpoint

public void setRadialTracedFootpoint(boolean value)

Sets the value indicating whether the radial traced footpoint regions are to be included in the listing.

Parameters:

value - new value

See Also:

isRadialTracedFootpoint()

isNorthBTracedFootpoint

public boolean isNorthBTracedFootpoint()

Gets the value indicating whether the north B traced footpoint regions are to be included in the listing.

Returns:

true if the north B traced footpoint regions are to be output, false if not

See Also:

setNorthBTracedFootpoint(boolean)

setNorthBTracedFootpoint

public void setNorthBTracedFootpoint(boolean value)

Sets the value indicating whether the north B traced footpoint regions are to be included in the listing.

Parameters:

value - new value

See Also:

isNorthBTracedFootpoint()

isSouthBTracedFootpoint

public boolean isSouthBTracedFootpoint()

Gets the value indicating whether the south B traced footpoint regions are to be included in the listing.

Returns:

true if the south B traced footpoint regions are to be output, false if not

See Also:

setSouthBTracedFootpoint(boolean)

setSouthBTracedFootpoint

public void setSouthBTracedFootpoint(boolean value)

Sets the value indicating whether the south B traced footpoint regions are to be included in the listing.

Parameters:

value - new value

See Also:

isSouthBTracedFootpoint()

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object