org.opensha.sha.calc.IM_EventSet.v03
Interface IM_EventSetCalc_v3_0_API

All Known Implementing Classes:
GUICalcAPI_Impl, IM_EventSetCalc_v3_0, IM_EventSetCalc_v3_0_ASCII

public interface IM_EventSetCalc_v3_0_API


Method Summary
 int getNumSites()
          Returns the number of sites for the calculation
 java.io.File getOutputDir()
          Returns the output directory for all results
 OrderedSiteDataProviderList getSiteDataProviders()
          Returns the ordered site data provider list, or null to not use site data providers
 Location getSiteLocation(int i)
          Returns the Location of the ith site.
 java.util.ArrayList<Site> getSites()
           
 java.util.ArrayList<java.util.ArrayList<SiteDataValue<?>>> getSitesData()
          This initializes the site data values for each site.
 java.util.ArrayList<SiteDataValue<?>> getUserSiteDataValues(int i)
          Returns the user specified (in the input file) site data values for the site or null to try to use site data providers
 

Method Detail

getNumSites

int getNumSites()
Returns the number of sites for the calculation

Returns:

getSiteLocation

Location getSiteLocation(int i)
Returns the Location of the ith site.

Parameters:
i -
Returns:

getSiteDataProviders

OrderedSiteDataProviderList getSiteDataProviders()
Returns the ordered site data provider list, or null to not use site data providers

Returns:

getUserSiteDataValues

java.util.ArrayList<SiteDataValue<?>> getUserSiteDataValues(int i)
Returns the user specified (in the input file) site data values for the site or null to try to use site data providers

Parameters:
i -
Returns:

getOutputDir

java.io.File getOutputDir()
Returns the output directory for all results

Returns:

getSitesData

java.util.ArrayList<java.util.ArrayList<SiteDataValue<?>>> getSitesData()
This initializes the site data values for each site. If there is user specified data for the specific site, that is given top priority. If there are also site data providers available, those will be used (but given lower priority than any user values).

Returns:

getSites

java.util.ArrayList<Site> getSites()