org.opensha.nshmp.sha.data.api
Interface DataGeneratorAPI_NEHRP

All Known Implementing Classes:
DataGenerator_FEMA, DataGenerator_IRC, DataGenerator_NEHRP

public interface DataGeneratorAPI_NEHRP

Title: DataGeneratorAPI_NEHRP

Description: this interface provides the minimum functionality that a DataGenerator classes must provide.

Version:
1.0
Author:
: Ned Field, Nitin Gupta and E.V.Leyendecker

Method Summary
 void calculatedSDSsS1()
           
 void calculateMapSpectrum()
           
 void calculateMapSpectrum(java.util.ArrayList<Location> locations, java.lang.String outfile)
          Computes the Map Spectrum(s) for the batch file.
 void calculateSDSpectrum()
           
 void calculateSDSpectrum(java.util.ArrayList<Location> locations, java.util.ArrayList<java.lang.String> conditions, java.lang.String outfile)
          Computes the SD Spectrum(s) for the batch file.
 void calculateSDSsS1(java.lang.String edition, java.lang.String region, java.lang.String zipCode, java.lang.String siteClass)
           
 void calculateSMSpectrum()
           
 void calculateSMSpectrum(java.util.ArrayList<Location> locations, java.util.ArrayList<java.lang.String> conditions, java.lang.String outfile)
          Computes the SM Spectrum(s) for the batch file.
 void calculateSMsSm1SDsSD1(java.util.ArrayList<Location> locations, java.util.ArrayList<java.lang.String> conditions, java.lang.String outfile)
           
 void calculateSMSsS1()
           
 void calculateSMSsS1(java.lang.String edition, java.lang.String region, java.lang.String zipCode, java.lang.String siteClass)
           
 void calculateSsS1()
          Gets the data for SsS1 in case Territory.
 void calculateSsS1(java.util.ArrayList<Location> locations, java.lang.String outFile)
          Gets the data for SsS1 for each location in the list of locations.
 void calculateSsS1(double lat, double lon)
          Gets the data for SsS1 in case region specified is not a Territory and user specifies Lat-Lon for the location.
 void calculateSsS1(java.lang.String zipCode)
          Gets the data for SsS1 in case region specified is not a Territory and user specifies zip code for the location.
 void clearData()
          Removes all the calculated data.
 java.lang.String getDataInfo()
          Returns the Data and all the metadata associated with it in a String.
 java.util.ArrayList getFunctionsToPlotForSA(boolean isMapSpectrumFunctionNeeded, boolean isSDSpectrumFunctionNeeded, boolean isSMSpectrumFunctionNeeded)
          Returns the list of functions for plotting.
 double getSa()
          Returns the SA at 1 sec
 java.lang.String getSelectedSiteClass()
          Returns the site class
 double getSs()
          Returns the SA at .2sec
 void setEdition(java.lang.String edition)
          Sets the selected data edition.
 void setFa(float fa)
          Sets the Fa value.
 void setFv(float fv)
          Sets the Fv value.
 void setNoLocation()
          Clears the lat/lon/zip values
 void setRegion(java.lang.String region)
          Sets the selected geographic region.
 void setSiteClass(java.lang.String siteClass)
          Sets the selected site class
 void setSpectraType(java.lang.String spectraType)
          Sets the Spectra type
 

Method Detail

clearData

void clearData()
Removes all the calculated data.


setNoLocation

void setNoLocation()
Clears the lat/lon/zip values


getDataInfo

java.lang.String getDataInfo()
Returns the Data and all the metadata associated with it in a String.

Returns:
String

calculateSsS1

void calculateSsS1()
                   throws java.rmi.RemoteException
Gets the data for SsS1 in case Territory. Territory is when user is not allowed to enter any zip code or Lat-Lon for the location or if it is GAUM and TAUTILLA.

Throws:
java.rmi.RemoteException

calculateSsS1

void calculateSsS1(double lat,
                   double lon)
                   throws java.rmi.RemoteException
Gets the data for SsS1 in case region specified is not a Territory and user specifies Lat-Lon for the location.

Throws:
java.rmi.RemoteException

calculateSsS1

void calculateSsS1(java.lang.String zipCode)
                   throws ZipCodeErrorException,
                          java.rmi.RemoteException
Gets the data for SsS1 in case region specified is not a Territory and user specifies zip code for the location.

Throws:
ZipCodeErrorException
java.rmi.RemoteException

calculateSsS1

void calculateSsS1(java.util.ArrayList<Location> locations,
                   java.lang.String outFile)
Gets the data for SsS1 for each location in the list of locations. If any given location is not valid for the current region, an error message is displayed and the output displays "Out of Region" information. Output is directed to the specified outFile Excel file.

Parameters:
locations - A list of locations to calculate SsS1 at.
outFile - The Excel file to output the information.

setSiteClass

void setSiteClass(java.lang.String siteClass)
Sets the selected site class

Parameters:
siteClass - String

getSelectedSiteClass

java.lang.String getSelectedSiteClass()
Returns the site class

Returns:
String

getFunctionsToPlotForSA

java.util.ArrayList getFunctionsToPlotForSA(boolean isMapSpectrumFunctionNeeded,
                                            boolean isSDSpectrumFunctionNeeded,
                                            boolean isSMSpectrumFunctionNeeded)
Returns the list of functions for plotting.

Parameters:
isMapSpectrumFunctionNeeded - boolean true if user has clicked the map spectrum button
isSDSpectrumFunctionNeeded - boolean true if user has clicked the SD spectrum button
isSMSpectrumFunctionNeeded - boolean true if user has clicked the SM spectrum button
Returns:
ArrayList

getSs

double getSs()
Returns the SA at .2sec

Returns:
double

getSa

double getSa()
Returns the SA at 1 sec

Returns:
double

calculateSMSsS1

void calculateSMSsS1()
                     throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

calculateSMSsS1

void calculateSMSsS1(java.lang.String edition,
                     java.lang.String region,
                     java.lang.String zipCode,
                     java.lang.String siteClass)
                     throws java.rmi.RemoteException
Parameters:
edition -
region -
zipCode -
siteClass -
Throws:
java.rmi.RemoteException

calculatedSDSsS1

void calculatedSDSsS1()
                      throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

calculateSDSsS1

void calculateSDSsS1(java.lang.String edition,
                     java.lang.String region,
                     java.lang.String zipCode,
                     java.lang.String siteClass)
                     throws java.rmi.RemoteException
Parameters:
edition -
region -
zipCode -
siteClass -
Throws:
java.rmi.RemoteException

calculateSMsSm1SDsSD1

void calculateSMsSm1SDsSD1(java.util.ArrayList<Location> locations,
                           java.util.ArrayList<java.lang.String> conditions,
                           java.lang.String outfile)
Parameters:
locations -
conditions -
outfile -

calculateMapSpectrum

void calculateMapSpectrum()
                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

calculateSMSpectrum

void calculateSMSpectrum()
                         throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

calculateSDSpectrum

void calculateSDSpectrum()
                         throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

setRegion

void setRegion(java.lang.String region)
Sets the selected geographic region.

Parameters:
region - String

setEdition

void setEdition(java.lang.String edition)
Sets the selected data edition.

Parameters:
edition - String

setFa

void setFa(float fa)
Sets the Fa value.

Parameters:
fa - double

setFv

void setFv(float fv)
Sets the Fv value.

Parameters:
fv - double

setSpectraType

void setSpectraType(java.lang.String spectraType)
Sets the Spectra type

Parameters:
spectraType - String

calculateMapSpectrum

void calculateMapSpectrum(java.util.ArrayList<Location> locations,
                          java.lang.String outfile)
Computes the Map Spectrum(s) for the batch file.

Parameters:
locations -
outfile -

calculateSMSpectrum

void calculateSMSpectrum(java.util.ArrayList<Location> locations,
                         java.util.ArrayList<java.lang.String> conditions,
                         java.lang.String outfile)
Computes the SM Spectrum(s) for the batch file.

Parameters:
locations -
conditions -
outfile -

calculateSDSpectrum

void calculateSDSpectrum(java.util.ArrayList<Location> locations,
                         java.util.ArrayList<java.lang.String> conditions,
                         java.lang.String outfile)
Computes the SD Spectrum(s) for the batch file.

Parameters:
locations -
conditions -
outfile -