ScenarioSettings

java.lang.Object
- earthproj.ScenarioSettings

```
public class ScenarioSettings
extends java.lang.Object
```
This class contains all of the user-specified simulation settings and the arrays of trajectory and radar objects. This is used to transfer all of the data and objects from the driver to the EarthView object.

Constructor Summary

Constructors
Constructor and Description

ScenarioSettings()
Default values are set.

Constructors
Constructor and Description
`ScenarioSettings()` Default values are set.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getATMLayerOption()` The purpose is to get the user-specified visible atmosphere layer status - it lets the EarthView object know whether or not to activate it.
`double[]`	`getClipDistances()` The purpose is to pass the clip distances to the EarthView object; these are in turn to passed to the CustomOrbitView object.
`boolean`	`getClipDistanceStatus()` The purpose is to set custom clip distance values.
`boolean`	`getMSVEarthAerialOption()` The purpose is to get the user-specified MSV Earth Aerial layer status - it lets the EarthView object know whether or not to activate it.
`RadarObjects[]`	`getRadarModels()` The purpose is to retrieve the radar objects array - this array contains all of the radar objects that will be used in the simulation.
`boolean`	`getStarsLayerOption()` The purpose is to get the user-specified visible stars layer status - it lets the EarthView object know whether or not to activate it.
`int`	`getTimeDelay()` The purpose is to pass the user-specified time delay value to the EarthView object for use in the simulation.
`TrajectoryObjects[]`	`getTrajectoryObjects()` The purpose is to retrieve the trajectory objects array - this contains the trajectory objects that will be used in the simulation.
`boolean`	`getUTMGridOption()` The purpose is to get the user-specified visible latitude / longitude grid pattern layer status - it lets the EarthView object know whether or not to activate it.
`double[]`	`getViewSettings()` The purpose is to build the [latitude,longitude,altitude] vector which sets the initial observer's view of the Earth when starting the simulation.
`void`	`loadRadarModels(RadarObjects[] ro)` The purpose is to load the radar objects array from the driver - this will then be retrieved by the EarthView object via another method.
`void`	`loadTrajectoryObjects(TrajectoryObjects[] to)` The purpose is to load the trajectory objects array from the driver - this will be then retrieved by the EarthView object via another method.
`void`	`setATMLayerOption(boolean ATMLayerStatus)` The purpose is to load the atmosphere layer status from the driver.
`void`	`setClipDistances(boolean setClipDistances)` The purpose is to load the clip distance status from the driver - the status determines whether or not CustomOrbitView will set the user-specified clip distances.
`void`	`setClipDistances(double nearClipDistanceVal, double farClipDistanceVal)` The purpose is to load the near and far clip distance values from the driver - these will be then retrieved by the EarthView object via another method.
`void`	`setMSVEarthAerialOption(boolean MSVEarthAerialStatus)` The purpose is to load the MSVEarthAerial layer status from the driver.
`void`	`setStarsLayerOption(boolean StarsLayerStatus)` The purpose is to load the star layer status from the driver.
`void`	`setTimeDelay(int timeDelay)` The purpose is to load the time delay value from the driver - this will be retrieved by the EarthView object via another method.
`void`	`setUTMGridOption(boolean UTMGridStatus)` The purpose is to load the Latitude - Longitude grid pattern layer status from the driver.
`void`	`setViewSettings(double[] vect)` The purpose is to load the 3-element vector, which contains the coordinates of the observer's initial Earth perspective, from the driver.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScenarioSettings
```
public ScenarioSettings()
```
    Default values are set.
- Method Detail
  - getClipDistances
```
public double[] getClipDistances()
```
    The purpose is to pass the clip distances to the EarthView object; these are in turn to passed to the CustomOrbitView object.
    
    Returns:
    
    The user-specified near and far clip distances.
  - getRadarModels
```
public RadarObjects[] getRadarModels()
```
    The purpose is to retrieve the radar objects array - this array contains all of the radar objects that will be used in the simulation.
    
    Returns:
    
    The array of radar objects.
  - getTrajectoryObjects
```
public TrajectoryObjects[] getTrajectoryObjects()
```
    The purpose is to retrieve the trajectory objects array - this contains the trajectory objects that will be used in the simulation.
    
    Returns:
    
    The array of trajectory objects.
  - getClipDistanceStatus
```
public boolean getClipDistanceStatus()
```
    The purpose is to set custom clip distance values. If return value is set to true, then the custom clip distance values will be used in the CustomOrbitView object.
    
    Returns:
    
    Status value (true or false) of the request to set custom clip distance values.
  - getTimeDelay
```
public int getTimeDelay()
```
    The purpose is to pass the user-specified time delay value to the EarthView object for use in the simulation.
    
    Returns:
    
    The user-specified time delay value.
  - getUTMGridOption
```
public boolean getUTMGridOption()
```
    The purpose is to get the user-specified visible latitude / longitude grid pattern layer status - it lets the EarthView object know whether or not to activate it.
    
    Returns:
    
    The boolean status for the UTMGrid layer.
  - getATMLayerOption
```
public boolean getATMLayerOption()
```
    The purpose is to get the user-specified visible atmosphere layer status - it lets the EarthView object know whether or not to activate it.
    
    Returns:
    
    The boolean status for the atmosphere layer.
  - getStarsLayerOption
```
public boolean getStarsLayerOption()
```
    The purpose is to get the user-specified visible stars layer status - it lets the EarthView object know whether or not to activate it.
    
    Returns:
    
    The boolean status for the stars layer.
  - getMSVEarthAerialOption
```
public boolean getMSVEarthAerialOption()
```
    The purpose is to get the user-specified MSV Earth Aerial layer status - it lets the EarthView object know whether or not to activate it.
    
    Returns:
    
    The boolean status for the MSV Earth Aerial layer.
  - getViewSettings
```
public double[] getViewSettings()
```
    The purpose is to build the [latitude,longitude,altitude] vector which sets the initial observer's view of the Earth when starting the simulation.
    
    Returns:
    
    The coordinates of the initial observer's view of the Earth.
  - loadRadarModels
```
public void loadRadarModels(RadarObjects[] ro)
```
    The purpose is to load the radar objects array from the driver - this will then be retrieved by the EarthView object via another method.
    
    Parameters:
    
    ro - The array of RadarObjects objects.
  - loadTrajectoryObjects
```
public void loadTrajectoryObjects(TrajectoryObjects[] to)
```
    The purpose is to load the trajectory objects array from the driver - this will be then retrieved by the EarthView object via another method.
    
    Parameters:
    
    to - The array of TrajectoryObjects objects.
  - setClipDistances
```
public void setClipDistances(double nearClipDistanceVal,
                             double farClipDistanceVal)
```
    The purpose is to load the near and far clip distance values from the driver - these will be then retrieved by the EarthView object via another method.
    
    Parameters:
    
    nearClipDistanceVal - The near clip distance value.
    
    farClipDistanceVal - The far clip distance value.
  - setClipDistances
```
public void setClipDistances(boolean setClipDistances)
```
    The purpose is to load the clip distance status from the driver - the status determines whether or not CustomOrbitView will set the user-specified clip distances. The status will be retrieved by the EarthView object via another method.
    
    Parameters:
    
    setClipDistances - Status (true or false) for using the user-specified clip distance values.
  - setTimeDelay
```
public void setTimeDelay(int timeDelay)
```
    The purpose is to load the time delay value from the driver - this will be retrieved by the EarthView object via another method.
    
    Parameters:
    
    timeDelay - The time delay value in milliseconds (integer).
  - setUTMGridOption
```
public void setUTMGridOption(boolean UTMGridStatus)
```
    The purpose is to load the Latitude - Longitude grid pattern layer status from the driver. If "true", this status value will be used by class EarthView to implement the UTMGrid layer in the Earth model.
    
    Parameters:
    
    UTMGridStatus - Sets the status (true or false) for the Earth UTM Grid layer.
  - setATMLayerOption
```
public void setATMLayerOption(boolean ATMLayerStatus)
```
    The purpose is to load the atmosphere layer status from the driver. If "true", this status value will be used by EarthView to implement the atmosphere layer.
    
    Parameters:
    
    ATMLayerStatus - Sets the status (true or false) for the Earth atmosphere layer.
  - setStarsLayerOption
```
public void setStarsLayerOption(boolean StarsLayerStatus)
```
    The purpose is to load the star layer status from the driver. If "true", this status value will be used by EarthView to implement the star layer.
    
    Parameters:
    
    StarsLayerStatus - Sets the status (true or false) for the Earth stars layer.
  - setMSVEarthAerialOption
```
public void setMSVEarthAerialOption(boolean MSVEarthAerialStatus)
```
    The purpose is to load the MSVEarthAerial layer status from the driver. If "true", this status value will be used by EarthView to implement the MSVEarthAerial layer.
    
    Parameters:
    
    MSVEarthAerialStatus - Sets the status (true or false) for the MSV Earth Aerial layer.
  - setViewSettings
```
public void setViewSettings(double[] vect)
```
    The purpose is to load the 3-element vector, which contains the coordinates of the observer's initial Earth perspective, from the driver. EarthView will use these values to set up the observer's perspective at the beginning.
    
    Parameters:
    
    vect - The 3-element vector which contains the coordinates of the observer's initial Earth perspective.

Class ScenarioSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScenarioSettings

Method Detail

getClipDistances

getRadarModels

getTrajectoryObjects

getClipDistanceStatus

getTimeDelay

getUTMGridOption

getATMLayerOption

getStarsLayerOption

getMSVEarthAerialOption

getViewSettings

loadRadarModels

loadTrajectoryObjects

setClipDistances

setClipDistances

setTimeDelay

setUTMGridOption

setATMLayerOption

setStarsLayerOption

setMSVEarthAerialOption

setViewSettings