Package hec.rss.model.globalvariable

Interface GlobalVariable

All Superinterfaces:
AsciiSerializable, FieldAccessor, Serializable
All Known Implementing Classes:
BaseGlobalVariable, ExternalGlobalVariable, ScalarGlobalVariable, StringGlobalVariable, TableGlobalVariable, TimeSeriesGlobalVariable
public interface GlobalVariable extends AsciiSerializable

  • Method Details

    • getName

      String getName()

    • setName

      void setName(String name)

    • getDescription

      String getDescription()

    • setDescription

      void setDescription(String desc)

    • getType

      GlobalVariableType getType()

    • isInput

      boolean isInput()

    • setInput

      void setInput(boolean isInput)

    • setIndex

      void setIndex(int globalVariableIndex)

    • getIndex

      int getIndex()

    • initializeGv

      boolean initializeGv()

    • clone

      GlobalVariable clone()

    • setGlobalVariableData

      void setGlobalVariableData(GlobalVariableData altGvData)

    • finalizeCompute

      void finalizeCompute()
      called at the end of the compute to do any compute related cleanup that's necessary;

    • getDescriptiveText

      String getDescriptiveText()
      gets a description of the type of the global variable
      Returns:
      descriptive text

    • getNetwork

      RssSystem getNetwork()
      get the Network from the GlobalVariable
      Returns:
      the GLobalVariable's network

    • hasValidValue

      String hasValidValue()
      check to see if the GlobalVariable has a valid value
      Returns:
      null if valid, message string if its not.

    • setIsDataLocation

      void setIsDataLocation(boolean isDataLocation)

    • getIsDataLocation

      boolean getIsDataLocation()

    • outputReport

      void outputReport(AlternativeInputReport report, org.jdom.Element child2)
      add the global variable data to the Alternative report
      Parameters:
      report -
      child2 -