Package hec.rss.model

Class HotstartState

java.lang.Object
hec.rss.model.HotstartState
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, Serializable
Direct Known Subclasses:
ElementHotstartState, FunctionHotstartState, InducedSurchargeOpHotstartState, NetworkHotstartState, OpControllerHotstartState, ResOpHotstartState, RoutingHotstartState
public abstract class HotstartState extends Object implements AsciiSerializable
See Also:

  • Field Details

  • Constructor Details

    • HotstartState

      public HotstartState()

    • HotstartState

      public HotstartState(String name, String objClass)

  • Method Details

    • saveState

      public abstract void saveState(int stateId)

    • restoreState

      public abstract boolean restoreState()

    • setObjectClass

      public void setObjectClass(String cls)

    • getObjectClass

      public String getObjectClass()

    • setName

      public void setName(String name)

    • getName

      public String getName()

    • addChildState

      public void addChildState(HotstartState state)

    • setParentState

      public void setParentState(HotstartState parent)

    • getHoursToSave

      public double getHoursToSave()

    • getHotstartTime

      public HecTime getHotstartTime()

    • getFilename

      public String getFilename()

    • addTimeSeries

      public void addTimeSeries(TimeSeriesContainer tsc)

    • getTimeSeriesList

      public List<TimeSeriesContainer> getTimeSeriesList()

    • getChildState

      public HotstartState getChildState(String name, String cls)
      get the HotstartState for the specified name and class
      Parameters:
      name - the name of the object
      cls - the class of the object
      Returns:
      the HotstartState or null

    • printErrorMessage

      protected void printErrorMessage(String msg)

    • printWarningMessage

      protected void printWarningMessage(String msg)

    • getSaveStartTime

      protected HecTime getSaveStartTime()

    • getCurrentRunTimeStep

      protected int getCurrentRunTimeStep()

    • calcNumStepsBack

      protected void calcNumStepsBack()

    • getNumStepsBack

      protected int getNumStepsBack()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getFieldObject

      public Object getFieldObject(Field fld)
      Description copied from interface: FieldAccessor
      This method allows access to java.lang.reflect.Field objects within the implementing class.
      Specified by:
      getFieldObject in interface FieldAccessor
      Parameters:
      fld - The field to get.
      Returns:
      The data object that is stored in the given field

    • setFieldObject

      public boolean setFieldObject(Field fld, Object fobj)
      Description copied from interface: FieldAccessor
      This allows access to fields withing the implementing object to set there data.
      Specified by:
      setFieldObject in interface FieldAccessor
      Parameters:
      fld - The java field object representing the member field to be set
      fobj - The data to set in that field
      Returns:
      returns true if successful