Package hec.rss.model

Class RuleConnectivityRef

java.lang.Object
hec.rss.model.RuleConnectivityRef
public class RuleConnectivityRef extends Object
RuleConnectivityRef is used in copying reservoir network elements to identify reservoir and diversion operating rule references to network components.

  • Field Details

    • DOWNSTREAM_NODE

      public static final int DOWNSTREAM_NODE
      Acceptable references include all nodes downstream of element being copied
      See Also:

    • ANY_NODE

      public static final int ANY_NODE
      Acceptable references include any node in the network
      See Also:

    • MODEL_VARIABLE

      public static final int MODEL_VARIABLE
      Acceptable references include simialar model variables
      See Also:

    • JUNCTION_NODE

      public static final int JUNCTION_NODE
      Acceptable references include downstream nodes of any junction in the network
      See Also:

    • RESERVOIR_ELEMENT

      public static final int RESERVOIR_ELEMENT
      Acceptable references include any reservoir element
      See Also:

    • STATE_VARIABLE

      public static final int STATE_VARIABLE
      See Also:

  • Constructor Details

    • RuleConnectivityRef

      public RuleConnectivityRef()
      default constructor

  • Method Details

    • setRule

      public void setRule(Object r)
      Set the Rule
      Parameters:
      r - should be either a Rule or OpRule object

    • getRule

      public Object getRule()
      get the Rule Object
      Returns:
      either Rule or OpRule

    • setLocation

      public void setLocation(Object l)
      Set the Location Object
      Parameters:
      l - may be an RssNode, Independent Variable, or Reservoir Element

    • getLocation

      public Object getLocation()
      get the Location Object
      Returns:
      either an RssNode, Independent Variable, or Reservoir Element

    • setLocationType

      public void setLocationType(int i)
      set the Location Type Id
      Parameters:
      i - the id

    • getLocationType

      public int getLocationType()
      get the Location Type Id
      Returns:
      the id