HTMLErrorLog Class

Write diagnostics items to an HTML file.

This class only utilizes the log-file rolling, and overrides the WriteHTMLContent(TextWriter) method.

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 HTMLErrorLog : HTMLLog
Inheritance
Object    HTMLLog    HTMLErrorLog

Constructors

HTMLErrorLogInitializes a new instance of the HTMLErrorLog class

Properties

CssStyle CSS style
(Inherited from HTMLLog)
FilePath The file path of the html file.
(Inherited from HTMLLog)
LogFileName File name of log file. Only used as part of the html output.
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)
Sections Sections in HTML file
(Inherited from HTMLLog)
SimulationID File name of simulation input file. Only used as part of the html output.
UnitProvider Unit provider, for unit conversions
(Inherited from HTMLLog)
UsesRainfallRunoff Flag indicating that rainfall runoff was used.

Methods

Add Collect a complete diagnostics items tree
AddIndexSection Add index-section to HTML Sections. After adding all other sections, you also need to call BuildIndex(HtmlContentSection).
(Inherited from HTMLLog)
BuildIndex Build an index in the indexHtmlItem. The index is based on all sections with a name defined.
(Inherited from HTMLLog)
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)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
HasErrors Returns true if there are errors in the log
HasWarnings Returns true if there are warnings in the log
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
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)
SetUseOfRR Helper method to evaluate if to set UsesRainfallRunoff
ToStringReturns a string that represents the current object.
(Inherited from Object)
Write Write log to disk
(Inherited from HTMLLog)
WriteErrorLog Writes an error log.
WriteFooter Write HTML Footer
(Inherited from HTMLLog)
WriteHeader Write HTML header
(Inherited from HTMLLog)
WriteHTMLContent Write HTML content, calling WriteHeader(TextWriter, String, String), WriteSections(TextWriter) and WriteFooter(TextWriter).
(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)
WriteSectionBegin Write start of section
(Inherited from HTMLLog)
WriteSections Write all sections to w
(Inherited from HTMLLog)

See Also