Package hms.model

Class Project

  • All Implemented Interfaces:
    java.lang.Comparable<Project>
    public class Project
extends Management
implements java.lang.Comparable<Project>
    Title: Java Model Code for HMS

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Saves all components, then closes project.
      void closeProject()
      Closes without saving data.
      void computeAll()
      Computes all simulation runs, forecast alternatives, optimization trials, depth-area analyses, and uncertainty analyses for this project.
      void computeDepthAreaAnalysis​(java.lang.String name)
      Computes a depth-area analysis.
      void computeForecast​(java.lang.String name)
      Computes a forecast alternative.
      void computeOptimization​(java.lang.String name)
      Computes an optimization trial.
      void computeRun​(java.lang.String name)
      Computes a simulation run.
      void computeUncertaintyAnalysis​(java.lang.String name)
      Computes an uncertainty analysis.
      static Project open​(java.lang.String pathToHmsFile)
      Opens a project.
      int saveAll()
      Saves all components.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • open

        public static Project open​(java.lang.String pathToHmsFile)
        Opens a project.
        Parameters:
        pathToHmsFile - the *.hms file location, e.g. "C:\projects\castro\castro.hms"
        Returns:
        the HMS project

      • computeAll

        public void computeAll()
        Computes all simulation runs, forecast alternatives, optimization trials, depth-area analyses, and uncertainty analyses for this project.

      • computeRun

        public void computeRun​(java.lang.String name)
        Computes a simulation run.
        Parameters:
        name - the simulation run name, e.g "current"
        Throws:
        java.lang.IllegalArgumentException - if the simulation run does not exist

      • computeForecast

        public void computeForecast​(java.lang.String name)
        Computes a forecast alternative.
        Parameters:
        name - the forecast alternative name
        Throws:
        java.lang.IllegalArgumentException - if the forecast alternative does not exist

      • computeOptimization

        public void computeOptimization​(java.lang.String name)
        Computes an optimization trial.
        Parameters:
        name - the optimization trial name
        Throws:
        java.lang.IllegalArgumentException - if the forecast alternative does not exist

      • computeDepthAreaAnalysis

        public void computeDepthAreaAnalysis​(java.lang.String name)
        Computes a depth-area analysis.
        Parameters:
        name - the depth-area analysis name
        Throws:
        java.lang.IllegalArgumentException - if the forecast alternative does not exist

      • computeUncertaintyAnalysis

        public void computeUncertaintyAnalysis​(java.lang.String name)
        Computes an uncertainty analysis.
        Parameters:
        name - the uncertainty analysis name
        Throws:
        java.lang.IllegalArgumentException - if the uncertainty analysis does not exist

      • closeProject

        public void closeProject()
        Closes without saving data. If you want to save data, check if there have been changes using modelDirty() method and if necessary save changes using saveAll() method.

      • close

        public void close()
        Saves all components, then closes project.

      • saveAll

        public int saveAll()
        Saves all components.