HTMLSummary Methods |
The HTMLSummary type exposes the following members.
Name | Description | |
---|---|---|
AddIndexSection |
Add index-section to HTML Sections.
After adding all other sections, you also need to call BuildIndex(HtmlContentSection).
(Inherited from HTMLLog.) | |
Balance |
Calculates volume balance for catchment
| |
BalancePct |
Calculates volume balance in percent of total inflow for catchment
| |
BuildIndex |
Build an index in the indexHtmlItem.
The index is based on all sections with a name defined.
(Inherited from HTMLLog.) | |
CreateSections |
Create sections for HTML summary
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
FormatDateTime |
Format a DateTime object as string
(Inherited from HTMLLog.)if time is DateTime.MinValue DateTime.MaxValue | |
FormatPercent | (Inherited from HTMLLog.) | |
FormatRatio |
Format a ratio or fraction value to string
(Inherited from HTMLLog.)if value is Double.MinValue Double.MaxValue | |
FormatTimeSpan |
Format a TimeSpan object as string
(Inherited from HTMLLog.) | |
FormatValue |
Perform unit conversion and format a value to string.
(Inherited from HTMLLog.)if value is Double.MinValue Double.MaxValue | |
FormatVolume |
Format volume value to string
| |
GetBoundaryItemsString |
Get boundary items for a given boundary as a string
| |
GetBoundaryLocationsString |
Get boundary locations for a given boundary as a string
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ReachEndNodeID |
Get start node ID, if it defined explicitly in setup (not auto-created). If auto-created, "-" is returned
| |
ReachGpQrelQfull |
Calculate relative discharge, relative to Q-full calculation
| |
ReachGpRelativeDepth |
Calculate relative depth, relative to cross section height
| |
ReachSelector |
Selector for reach based tables
| |
ReachStartNodeID |
Get start node ID, if it defined explicitly in setup (not auto-created). If auto-created, "-" is returned
| |
RollLogFile |
Rename an existing log file with name NAME.html to NAME001.html and NAME001.html to NAME002.html etc.
If _maxNumberOfErrorLogFileBackups == 0 then this does nothing (no backups are created)
(Inherited from HTMLLog.) | |
SetCouplingSummary |
provide coupling summary information to HTMLSummary
| |
SetModelType |
Set type of model, used in coupling context.
| |
StrucInfoFilter(ListHTMLSummaryStructureInfo, FuncHTMLSummaryStructureInfo, Boolean) |
Create list of StrucInfoFilter(ListHTMLSummaryStructureInfo, FuncHTMLSummaryStructureInfo, Boolean) containing only structures selected by selector | |
StrucInfoFilterT(ListHTMLSummaryStructureInfo) |
Create list of StrucInfoFilter(ListHTMLSummaryStructureInfo, FuncHTMLSummaryStructureInfo, Boolean) containing only structures of given type
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TotalBalancePct |
Calculates volume balance in percent of total inflow for all catchments
| |
TotalInflow |
Calculates total inflow to catchment
| |
Write |
Write log to disk
(Inherited from HTMLLog.) | |
WriteBoundaryConnections |
Add boundary connection sections
| |
WriteFileOverview |
Add File Overview section
| |
WriteFooter |
Write HTML Footer
(Inherited from HTMLLog.) | |
WriteHDResultSummary |
Add HD Result Summary section
| |
WriteHDSummary |
Add HD summary section
| |
WriteHeader |
Write HTML header
(Inherited from HTMLLog.) | |
WriteHTMLContent |
Write content as HTML to writer (Overrides HTMLLogWriteHTMLContent(TextWriter).) | |
WriteIndexLink |
Write an index-link - link to a section. Must match WriteSectionBegin(TextWriter, String) (Inherited from HTMLLog.) | |
WriteItemBegin |
Write start of item in section
(Inherited from HTMLLog.) | |
WriteNotRun |
Write section: simulation did not run
| |
WriteRRLIDsSummary |
Writes RR-LIDs result summary
| |
WriteRRResultSummary |
Writes RR result summary
| |
WriteRRSummary |
Add RR summary
| |
WriteSectionBegin |
Write start of section
(Inherited from HTMLLog.) | |
WriteSections |
Write all sections to w (Inherited from HTMLLog.) | |
WriteSimulationHasErrors |
Write section: simulation has errors
| |
WriteSimulationType |
Write simulation type section.
| |
WriteTableHeader |
Write headers as table headers
| |
WriteTimeOverview |
Add Time Overview section
|