Interface Simulation

All Known Implementing Classes:
AbstractSimulation, SimulationPeriod

public interface Simulation
  • Method Details

    • getName

      String getName()
      Returns the name of the simulation
    • getDescription

      String getDescription()
      Returns the description of the simulation
    • setModified

      void setModified(boolean modified)
      Sets the Modified attribute of the Simulation object
      Parameters:
      modified - The new Modified value
    • acceptTrial

      void acceptTrial(SimulationRun run, AltItem altItem, int modelPos, String trialKey)
      Description of the Method
      Parameters:
      run - Description of Parameter
      altItem - Description of Parameter
      modelPos - Description of Parameter
      trialKey - Description of Parameter
    • removeTrial

      boolean removeTrial(AltItem altItem, TrialReference trialRef)
    • compute

      boolean compute()
      Description of the Method
      Returns:
      Description of the Returned Value
    • getStreamAlignment

      StreamAlignment getStreamAlignment()
      Gets the StreamAlignment attribute of the Simulation object
      Returns:
      The StreamAlignment value
    • getTimeWindowString

      String getTimeWindowString()
      Gets the TimeWindowString attribute of the Simulation object
      Returns:
      The TimeWindowString value
    • getTimeWindow

      boolean getTimeWindow(HecTime start, HecTime end)
      Gets the TimeWindow attribute of the Simulation object
      Parameters:
      start - Description of Parameter
      end - Description of Parameter
      Returns:
      The TimeWindow value
    • getStartDateString

      String getStartDateString()
      Gets the StartDateString attribute of the Simulation object
      Returns:
      The StartDateString value
    • setStartDate

      void setStartDate(String date)
      Sets the StartDate attribute of the Simulation object
      Parameters:
      date - The new StartDate value
    • getEndDateString

      String getEndDateString()
      Gets the EndDateString attribute of the Simulation object
      Returns:
      The EndDateString value
    • setEndDate

      void setEndDate(String date)
      Sets the EndDate attribute of the Simulation object
      Parameters:
      date - The new EndDate value
    • getLookbackDateString

      String getLookbackDateString()
      Gets the LookbackDateString attribute of the Simulation object
      Returns:
      The LookbackDateString value
    • setLookbackDate

      void setLookbackDate(String date)
      Sets the LookbackDate attribute of the Simulation object
      Parameters:
      date - The new LookbackDate value
    • getModelTrials

      Vector getModelTrials(String program, String id)
    • getUnusedModelTrials

      Vector getUnusedModelTrials(String program, String id)
    • getTrialRunNames

      Vector getTrialRunNames()
      returns a Vector of the names of the SimulationTrialRuns that this SimulationPeriod holds
    • createNewTrialRun

      TrialRun createNewTrialRun(String newTrialName, String userName, String trialKey, SimulationRun parent, TrialRun baseTrial, int modelPosition)