Click or drag to resize

HTMLSummary Class

Write a summary of a simulation to an HTML file.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.GenericHTMLLog
    DHI.Mike1D.Mike1DDataAccessHTMLSummary

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 HTMLSummary : HTMLLog

The HTMLSummary type exposes the following members.

Constructors
  NameDescription
Public methodHTMLSummary(IMike1DController)
Default constructor
Public methodHTMLSummary(IMike1DController, HTMLSections)
Constructor providing sections where to add the section an items from MIKE 1D.
Top
Properties
  NameDescription
Public propertyCssStyle
CSS style
(Inherited from HTMLLog.)
Public propertyFilePath
The file path of the html file.
(Inherited from HTMLLog.)
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 propertyOnlyIndependentStructures
Only report independent structures, i.e. structures located on a structure reach, and not inside an ordinary reach.
Public propertySections
Sections in HTML file
(Inherited from HTMLLog.)
Public propertySimulationHasErrors
Boolean indicating if setup has errors
Public propertyUnitProvider
Unit provider, for unit conversions
(Inherited from HTMLLog.)
Public propertyWallTimeSimulationEnd
Wall clock Time were simulation ended
Public propertyWallTimeSimulationStart
Wall clock Time were simulation started
Top
Methods
  NameDescription
Public methodAddIndexSection
Add index-section to HTML Sections. After adding all other sections, you also need to call BuildIndex(HtmlContentSection).
(Inherited from HTMLLog.)
Protected methodStatic memberBalance
Calculates volume balance for catchment
Protected methodStatic memberBalancePct
Calculates volume balance in percent of total inflow for catchment
Public methodBuildIndex
Build an index in the indexHtmlItem. The index is based on all sections with a name defined.
(Inherited from HTMLLog.)
Public methodCreateSections
Create sections for HTML summary
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.)
Protected methodFormatVolume
Format volume value to string
Protected methodGetBoundaryItemsString
Get boundary items for a given boundary as a string
Protected methodStatic memberGetBoundaryLocationsString
Get boundary locations for a given boundary as a string
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodStatic memberReachEndNodeID
Get start node ID, if it defined explicitly in setup (not auto-created). If auto-created, "-" is returned
Protected methodReachGpQrelQfull
Calculate relative discharge, relative to Q-full calculation
Protected methodReachGpRelativeDepth
Calculate relative depth, relative to cross section height
Protected methodReachSelector
Selector for reach based tables
Protected methodStatic memberReachStartNodeID
Get start node ID, if it defined explicitly in setup (not auto-created). If auto-created, "-" is returned
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 methodSetCouplingSummary
provide coupling summary information to HTMLSummary
Public methodSetModelType
Set type of model, used in coupling context.
Protected methodStrucInfoFilter(ListHTMLSummaryStructureInfo, FuncHTMLSummaryStructureInfo, Boolean)
Protected methodStrucInfoFilterT(ListHTMLSummaryStructureInfo)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodStatic memberTotalBalancePct
Calculates volume balance in percent of total inflow for all catchments
Protected methodStatic memberTotalInflow
Calculates total inflow to catchment
Public methodWrite
Write log to disk
(Inherited from HTMLLog.)
Public methodWriteBoundaryConnections
Add boundary connection sections
Public methodWriteFileOverview
Add File Overview section
Protected methodWriteFooter
Write HTML Footer
(Inherited from HTMLLog.)
Public methodWriteHDResultSummary
Add HD Result Summary section
Public methodWriteHDSummary
Add HD summary section
Protected methodWriteHeader
Write HTML header
(Inherited from HTMLLog.)
Protected methodWriteHTMLContent
Write content as HTML to writer
(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 methodWriteNotRun
Write section: simulation did not run
Public methodWriteRRLIDsSummary
Writes RR-LIDs result summary
Public methodWriteRRResultSummary
Writes RR result summary
Public methodWriteRRSummary
Add RR summary
Protected methodWriteSectionBegin
Write start of section
(Inherited from HTMLLog.)
Protected methodWriteSections
Write all sections to w
(Inherited from HTMLLog.)
Protected methodWriteSimulationHasErrors
Write section: simulation has errors
Public methodWriteSimulationType
Write simulation type section.
Protected methodWriteTableHeader
Write headers as table headers
Public methodWriteTimeOverview
Add Time Overview section
Top
Fields
  NameDescription
Protected field_controller
Controller to write summary for
Top
See Also