WMS:WMLibOutletPoint
Description
The public class OutletPoint class manages hydrologic information for an outlet point in the hydrologic tree.
Functions
- public OutletPoint(WMLib.HydroTree a_tree, WMLib.OutletPoint a_downstreamOutlet, double a_lagTime, string a_name)
This function is the constructor function for an instance of an OutletPoint class. When creating an OutletPoint, pass this function the following information: the hydrologic tree (a_tree), a downstream outlet (a_downstreamOutlet, null signifies that the specified outlet is the most downstream outlet. Only a single downstream outlet is allowed for each model.), the outlet lag time (a_lagTime, minutes), and the outlet combine name (a_name). An outlet will be created with the specified combine name and with the same route name. The lag time is not used in the HEC-1 simulation, but is used with the ApplyLagTimes function in the HydroTree to route the hydrographs at the outlets based on their lag times. See the example in the introduction as an example of how this function is used.
- public System.Collections.Generic.List<TimeSeriesPoint> GetHydrograph()
After HEC-1 has been run, you can get the hydrograph at an outlet point by calling GetHydrograph, which returns a list of time series points.
- public double GetPeakFlow()
After HEC-1 has been run, you can get the peak hydrograph flow for the outlet point by calling this function.
- public System.DateTime GetPeakTime()
After HEC-1 has been run, you can get the time of the peak hydrograph flow for the outlet point by calling this function.
- public System.Collections.Generic.List<TimeSeriesPoint> GetRouteHydrograph()
After HEC-1 has been run, you can get the route hydrograph at an outlet point by calling GetRouteHydrograph, which returns a list of time series points.
- public double GetRoutePeakFlow()
After HEC-1 has been run, you can get the peak route hydrograph flow for the outlet point by calling this function.
- public System.DateTime GetRoutePeakTime()
After HEC-1 has been run, you can get the time of the peak route hydrograph flow for the outlet point by calling this function.
- public double GetLagTime()
Get the lag time for the outlet (in minutes) by calling this function.
- public void SetLagTime(double a_lagTime)
Set the lag time for the outlet by calling this function. The lag time must be passed in minutes.
Accessible Member Variables
- public string m_combineName { set; get; }
The combine name for the outlet. You are allowed to both get and set this variable. Do not create two outlets with the same combine name.
- public string m_routeName { set; get; }
The route name for the outlet. You are allowed to both get and set this variable. Do not create two outlets with the same route name.
