Package hec.data.fragilitycurve

Class FragilityCurvePairedDataContainer

java.lang.Object
hec.data.fragilitycurve.FragilityCurvePairedDataContainer
public class FragilityCurvePairedDataContainer extends Object

  • Constructor Details

    • FragilityCurvePairedDataContainer

      public FragilityCurvePairedDataContainer()

    • FragilityCurvePairedDataContainer

      public FragilityCurvePairedDataContainer(FragilityCurvePairedDataContainer fragilityCurveOutputLocation)
      Parameters:
      fragilityCurveOutputLocation -

  • Method Details

    • getFragilityCurvePairedDataContainer

      public static FragilityCurvePairedDataContainer getFragilityCurvePairedDataContainer(DSSIdentifier dssId)
      get the FragilityCurvePairedDataContainer from the location specified by the DSSIdentifier
      Parameters:
      dssId - the DSSIdentifier for a PDC that holds the FragilityCurvePairedDataContainer's information
      Returns:
      the FragilityCurvePairedDataContainer or null if there's an error

    • getFragilityCurvePairedDataContainer

      public static FragilityCurvePairedDataContainer getFragilityCurvePairedDataContainer(String dssFile, String dssPath)
      get the FragilityCurvePairedDataContainer from the location specified by the DSS File and DSS path
      Parameters:
      dssFile - the DSS file that holds the PairedDataContainer that holds the FragilityCurvePairedDataContainer information
      dssPath - the DSS path that holds the PairedDataContainer that holds the FragilityCurvePairedDataContainer information
      Returns:
      the FragilityCurvePairedDataContainer or null if there's an error

    • getFragilityCurvePairedDataContainer

      public static FragilityCurvePairedDataContainer getFragilityCurvePairedDataContainer(PairedDataContainer pdc)
      get the FragilityCurvePairedDataContainer from the DSS PairedDataContainer
      Parameters:
      pdc - the PairedDataContainer that holds the FragilityCurvePairedDataContainer's information
      Returns:
      the FragilityCurvePairedDataContainer or null if there's an error loading the data.

    • setPairedDataContainer

      public void setPairedDataContainer(PairedDataContainer pdc)

    • initialize

      public void initialize(String locName, DSSIdentifier dssId, DSSPathname pathname, int unitSystem)
      Parameters:
      pathname -
      dssId -
      locName -

    • getPairedDataContainer

      public PairedDataContainer getPairedDataContainer()
      Returns:

    • setFilename

      public void setFilename(String dssFilename)
      set the dss filename for saving data
      Parameters:
      dssFilename -

    • setSampledProbabilityAndElevation

      public void setSampledProbabilityAndElevation(double prob, double elevation)
      set the breach elevation and the associated probability
      Parameters:
      prob -
      elevation -

    • setSampledDuration

      public void setSampledDuration(Double durationInHours)
      sets the duration above which the breach elevation needs to be exceeded to trigger a failure
      Parameters:
      durationInHours -

    • getDurationInHours

      public Double getDurationInHours()
      returns the duration that the breach elevation needs to be exceeded to trigger failure
      Returns:
      the duration in hours, or null if duration wasn't used or the FragliityCurvePariedDataContainer was successfully read

    • setBreachMethod

      public void setBreachMethod(StructureBreachMethods breachMethod)
      sets the breach method for this structure
      Parameters:
      breachMethod -

    • getBreachMethod

      public StructureBreachMethods getBreachMethod()
      returns the breach method for this structure
      Returns:
      the breach method or null if the FragilityCurvePaire

    • getFailureModeName

      public String getFailureModeName()
      returns the name of the Failure Mode
      Returns:
      the Failure Mode or null if the FragilityCurvePairedDataContainer

    • setFailureModeName

      public void setFailureModeName(String failureModeName)
      sets the name of the failure mode
      Parameters:
      failureModeName -

    • getPathname

      public String getPathname()
      returns the pathname of the backing Paired Data Container
      Returns:

    • updatePDCFields

      public void updatePDCFields(String filename)

    • getFilename

      public String getFilename()
      Returns:

    • getFullname

      public String getFullname()
      Returns:

    • getBreachProbability

      public double getBreachProbability()
      sets the breach elevation for the given structure
      Returns:
      the breach probability or undefined double if the FragilityCurvePairedDataContainer was successfully parsed

    • getBreachElevation

      public double getBreachElevation()
      returns the breach elevation for the given structure
      Returns:
      the breech elevation or undefined double if the FragilityCurvePairedDataContainer was successfully parsed

    • successfullyReadPDC

      public boolean successfullyReadPDC()
      This signifies if the PDC was correctly parsed when attempting to read the output paired data container
      Returns:
      true if the backing PairedDataContainer was successfully parsed.

    • setFullname

      public void setFullname(String pathname)
      Parameters:
      pathname -

    • setVersion

      public void setVersion(String fPart)
      Parameters:
      fPart -