HTMLSummary Class

Write a summary of a simulation to an HTML file.

Definition

Namespace: DHI.Mike1D.Mike1DDataAccess
Assembly: DHI.Mike1D.Mike1DDataAccess (in DHI.Mike1D.Mike1DDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class HTMLSummary : HTMLLog
Inheritance
Object    HTMLLog    HTMLSummary

Constructors

HTMLSummary(IMike1DController) Default constructor
HTMLSummary(IMike1DController, HTMLSections) Constructor providing sections where to add the section an items from MIKE 1D.

Properties

CssStyle CSS style
(Inherited from HTMLLog)
FilePath The file path of the html file.
(Inherited from HTMLLog)
MaxNumberOfFileBackups Number of backups of the error log. If a *name*.html log file exists, then it is backed up with a *name*01.html ending. If *name*01.html exists, then it is moved to *name*02.html etc. MaxNumberOfErrorLogFileBackups is the last number of the backed up files. The last backed up file is deleted. The default value is 10.
(Inherited from HTMLLog)
OnlyIndependentStructures Only report independent structures, i.e. structures located on a structure reach, and not inside an ordinary reach.
Sections Sections in HTML file
(Inherited from HTMLLog)
SimulationHasErrors Boolean indicating if setup has errors
UnitProvider Unit provider, for unit conversions
(Inherited from HTMLLog)
WallTimeSimulationEnd Wall clock Time were simulation ended
WallTimeSimulationStart Wall clock Time were simulation started

Methods

AddIndexSection Add index-section to HTML Sections. After adding all other sections, you also need to call BuildIndex(HtmlContentSection).
(Inherited from HTMLLog)
AppendCouplingSummary Add subsection summary information from external parties to the HTMLSummary. This method appends to the total list of coupling summaries each time it is called. Used to gather subreports from both model couplings and Data Assimilation.
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
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows 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

if time is DateTime.MinValue or DateTime.MaxValue, "-" is returned


(Inherited from HTMLLog)
FormatPercent Format a % value to string

if value is Double.MinValue or Double.MaxValue, "-" is returned


(Inherited from HTMLLog)
FormatRatio Format a ratio or fraction value to string

if value is Double.MinValue or Double.MaxValue, "-" is returned


(Inherited from HTMLLog)
FormatTimeSpan Format a TimeSpan object as string
(Inherited from HTMLLog)
FormatValue Perform unit conversion and format a value to string.

if value is Double.MinValue or Double.MaxValue, "-" is returned


(Inherited from HTMLLog)
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
GetDistributedBoundaryLocationString Get boundary locations for a given distributed boundary as a string
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates 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 
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
ToStringReturns 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

Fields

_controller Controller to write summary for

See Also