Click or drag to resize

HTMLErrorLog Class

Write diagnostics items to an HTML file.

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

Inheritance Hierarchy
SystemObject
  DHI.Mike1D.GenericHTMLLog
    DHI.Mike1D.Mike1DDataAccessHTMLErrorLog

Namespace:  DHI.Mike1D.Mike1DDataAccess
Assembly:  DHI.Mike1D.Mike1DDataAccess (in DHI.Mike1D.Mike1DDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class HTMLErrorLog : HTMLLog

The HTMLErrorLog type exposes the following members.

Constructors
  NameDescription
Public methodHTMLErrorLog
Initializes a new instance of the HTMLErrorLog class
Top
Properties
  NameDescription
Public propertyCssStyle
CSS style
(Inherited from HTMLLog.)
Public propertyFilePath
The file path of the html file.
(Inherited from HTMLLog.)
Public propertyLogFileName
File name of log file. Only used as part of the html output.
Public propertyMaxNumberOfFileBackups
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.)
Public propertySections
Sections in HTML file
(Inherited from HTMLLog.)
Public propertySimulationID
File name of simulation input file. Only used as part of the html output.
Public propertyUnitProvider
Unit provider, for unit conversions
(Inherited from HTMLLog.)
Public propertyUsesRainfallRunoff
Flag indicating that rainfall runoff was used.
Top
Methods
  NameDescription
Public methodAdd
Collect a complete diagnostics items tree
Public methodAddIndexSection
Add index-section to HTML Sections. After adding all other sections, you also need to call BuildIndex(HtmlContentSection).
(Inherited from HTMLLog.)
Public methodBuildIndex
Build an index in the indexHtmlItem. The index is based on all sections with a name defined.
(Inherited from HTMLLog.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFormatDateTime
Format a DateTime object as string

if time is

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

(Inherited from HTMLLog.)
Public methodFormatPercent
Format a % value to string

if value is

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

(Inherited from HTMLLog.)
Public methodFormatRatio
Format a ratio or fraction value to string

if value is

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

(Inherited from HTMLLog.)
Public methodFormatTimeSpan
Format a TimeSpan object as string
(Inherited from HTMLLog.)
Public methodFormatValue
Perform unit conversion and format a value to string.

if value is

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

(Inherited from HTMLLog.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasErrors
Returns true if there are errors in the log
Public methodHasWarnings
Returns true if there are warnings in the log
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRollLogFile
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.)
Public methodSetUseOfRR
Helper method to evaluate if to set UsesRainfallRunoff
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWrite
Write log to disk
(Inherited from HTMLLog.)
Public methodWriteErrorLog
Writes an error log.
Protected methodWriteFooter
Write HTML Footer
(Inherited from HTMLLog.)
Protected methodWriteHeader
Write HTML header
(Inherited from HTMLLog.)
Protected methodWriteHTMLContent (Overrides HTMLLogWriteHTMLContent(TextWriter).)
Protected methodWriteIndexLink
Write an index-link - link to a section. Must match WriteSectionBegin(TextWriter, String)
(Inherited from HTMLLog.)
Public methodWriteItemBegin
Write start of item in section
(Inherited from HTMLLog.)
Protected methodWriteSectionBegin
Write start of section
(Inherited from HTMLLog.)
Protected methodWriteSections
Write all sections to w
(Inherited from HTMLLog.)
Top
See Also