WMS:WMLibRainfallData: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
(Created page with "== Description == The '''public class RainfallData''' class manages rainfall data for each sub-basin in the hydrologic tree. == Functions == *'''public RainfallData(double a_t...")
 
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 7: Line 7:
*'''public RainfallData(double a_totalRainfall, System.Collections.Generic.List<TimeSeriesPoint> a_data)'''
*'''public RainfallData(double a_totalRainfall, System.Collections.Generic.List<TimeSeriesPoint> a_data)'''


This function is the constructor function for an instance of an '''RainfallData''' class.  When creating rainfall data, you need to define a total rainfall value (a_totalRainfall, minutes) and a cumulative rainfall distribution (a_data).  The cumulative rainfall distribution is a list of time series points, each point describing a time and a value describing the cumulative rainfall value at that time.  To get the times in all the rainfall distributions to match the starting time of the job control data, use the '''SetRainfallTimesToJobControl''' function in the '''HydroTree''' class.  See the example in the [[WMS:WMLib|introduction]] as an example of how this function is used.
This function is the constructor function for an instance of an '''RainfallData''' class.  When creating rainfall data, you need to define a total rainfall value ('''a_totalRainfall''', minutes) and a cumulative rainfall distribution ('''a_data''').  The cumulative rainfall distribution is a list of time series points, each point describing a time and a value describing the cumulative rainfall value at that time.  To get the times in all the rainfall distributions to match the starting time of the job control data, use the '''SetRainfallTimesToJobControl''' function in the '''HydroTree''' class.  See the example in the [[WMS:WMLib|introduction]] as an example of how this function is used.


{{WMLibMain}}
{{WMLibMain}}
[[Category:WMLib|Rainfall]]

Latest revision as of 19:10, 11 January 2017

Description

The public class RainfallData class manages rainfall data for each sub-basin in the hydrologic tree.

Functions

  • public RainfallData(double a_totalRainfall, System.Collections.Generic.List<TimeSeriesPoint> a_data)

This function is the constructor function for an instance of an RainfallData class. When creating rainfall data, you need to define a total rainfall value (a_totalRainfall, minutes) and a cumulative rainfall distribution (a_data). The cumulative rainfall distribution is a list of time series points, each point describing a time and a value describing the cumulative rainfall value at that time. To get the times in all the rainfall distributions to match the starting time of the job control data, use the SetRainfallTimesToJobControl function in the HydroTree class. See the example in the introduction as an example of how this function is used.