CatchmentFromTimeSeries Methods |
The CatchmentFromTimeSeries type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Accepts | (Inherited from Catchment.) |
| AddToOffers | (Inherited from Catchment.) |
| ApplyBoundary(ICatchmentSourceBoundary) |
Apply a boundary to this catchment
(Inherited from Catchment.) |
| ApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource) |
Apply a boundary to this catchment
(Overrides CatchmentApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource).) |
| ApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) |
Apply a boundary to this catchment
(Overrides CatchmentApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource).) |
 | ApplyBoundaryLIDs(GlobalGeoLocatedSource) |
Apply boundary to LID's in catchment
(Inherited from Catchment.) |
| ApplyBoundaryLIDs(ICatchmentSourceBoundary) |
Apply boundary to LID's in catchment
(Inherited from Catchment.) |
| ApplyBoundaryLIDs(CatchmentSourceBoundaryTypes, IBoundarySource) |
Apply boundary to LID's in catchment
(Inherited from Catchment.) |
| ApplyBoundaryLIDs(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) |
Apply boundary to LID's in catchment
(Inherited from Catchment.) |
| BoundaryTypeIsAdditive |
Return true if boundaries of the specified type are additive; the contributions of
two discharge boundaries add up, while two temperature boundaries do not.
(Inherited from Catchment.) |
| CalculateStatistics |
Calculate statistics.
(Inherited from CatchmentState.)Called at end of each time step, by PerformTimeStep |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
Destructor
(Inherited from Catchment.) |
| FinalizeTimeStep | Finalizes the time step for the catchment. (Inherited from Catchment.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetRequiredTypes |
Get the type of boundary required by this catchment
(Overrides CatchmentGetRequiredTypes.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetYearlyStat |
Get or create a RRYearlyStat object for the specified year.
(Inherited from Catchment.) |
| Initialize |
Initialize Rainfall Runoff model. Sets up static data.
(Overrides CatchmentInitialize(IDiagnostics).) |
| InitializePlugins |
Initializes the cathcment plugins.
(Inherited from Catchment.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Offers |
List of data types that is offered and can be used in GetValue
(Inherited from Catchment.) |
| PerformTimeStep |
This procedure forwards the calculation with one time step.
(Inherited from Catchment.) |
| Prepare |
Prepare Rainfall Runoff model. Sets up dynamic data so that the model is ready for first time step.
(Overrides CatchmentPrepare(DateTime, DateTime, RRParameters, IDiagnostics).) |
| PrepareForTimeStep | Prepares the catchment for the time step. (Inherited from Catchment.) |
| PreparePlugins |
Prepares the cathcment plugins.
(Inherited from Catchment.) |
| PrepareSource |
Prepare boundary source.
(Inherited from Catchment.) |
| PrepareState |
Prepare state for new simulation.
(Inherited from CatchmentState.) |
| ReadPluginStates |
Write current state of plugins
(Inherited from Catchment.) |
| Reset |
Reset the catchment and set the current time.
(Inherited from Catchment.) |
| ResetBoundaries |
Remove boundaries applied in previous runs
(Inherited from Catchment.) |
| StateUpdated |
If state has been updated from outside, call this method to recalculate state dependent parameters.
(Inherited from CatchmentState.) |
| TakeTimeStep |
This procedure forwards the calculation with one time step.
(Overrides CatchmentTakeTimeStep.) |
| TimeOffers |
List of data types that is offered and can be used in GetValue
(Inherited from Catchment.) |
| TimeOfNextUpdate | Obsolete.
Return the time of next update. Used for PostTimeStepEvent event in Catchments.
(Overrides CatchmentTimeOfNextUpdate.) |
| TimeValueGetter |
Get value getter for the specified data quantity
(Inherited from Catchment.) |
| ToString | Returns a string that represents the current object. (Inherited from Catchment.) |
| TransferToStateVariableTable |
This routine stores the calculated variables in variables ready for export. The values in these state variable
corresponds to the values written to the result file. All discharge variables are subject to a unit conversion.
During the calculation discharges are calculated using the unit mm/hour and must therefor be converted into m3/s.
(Overrides CatchmentStateTransferToStateVariableTable.) |
| TriggerPostTimeStepEvent |
Trigger the PostTimeStepEvent, called at end of a time step.
(Inherited from Catchment.) |
| Type |
The type of catchment: NAM, Urban A etc
(Overrides CatchmentType.) |
| Update |
Update internal state of catchment to time Time()
(Overrides CatchmentUpdate(DateTime).) |
| UpdateCheckPointTime |
Updates check point time.
(Inherited from Catchment.) |
| UpdateRouting | Updates the routing for the catchment. (Inherited from Catchment.) |
| UpdateStorage | Updates the storage for the catchment. (Inherited from Catchment.) |
| UpdateTime |
Update time, setting _timeNew to _timeOld + _effectiveTimeStep.
This method will assue that _timeNew does not go beyond _endTime, by
modifying _effectiveTimeStep.
Before calling UpdateTime, be sure that _effectiveTimeStep is set.
(Inherited from Catchment.) |
| UpdateTimeStepUsingCheckPoint |
Updates the present time if it is greater than the check point time.
(Inherited from Catchment.) |
| Validate |
Validate that the catchment is set up correctly
(Inherited from Catchment.) |
| ValidateLIDs |
Validate all LIDs in catchment
(Inherited from Catchment.) |
| ValueGetter |
Get value setter for the specified data quantity
(Inherited from Catchment.) |
| ValueSetter | (Inherited from Catchment.) |
| VolumeInCatchment |
Volume of water stored in catchment after previous time step.
(Inherited from Catchment.) |
| VolumeInCatchmentAtStart |
Volume of water stored in catchment after previous time step.
(Inherited from Catchment.) |
| WritePluginStates |
Write current state of plugins
(Inherited from Catchment.) |
See Also