Click or drag to resize

Mike1DLogFileWriter Class

Log file writer for MIKE 1D engine.

Call Prepare to open the logfile. If prepare is not called, all writing to the logfile is ignored silently.

Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Mike1DDataAccessMike1DLogFileWriter

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 Mike1DLogFileWriter

The Mike1DLogFileWriter type exposes the following members.

Constructors
  NameDescription
Public methodMike1DLogFileWriter
Default constructor, setting the default log file name
Top
Properties
  NameDescription
Public propertyIncludeExceptionStackTrace
Flag specifying whether the exception stack trace should be written to the log file, in case of an exception. The exception message is always written to the log file.
Public propertyLogFileName
Name and full path of log file. By default the name is the setup name where the extension is replaced by ".log". Another name can be specified here.
Public propertyLogFileOpen
Flag indicating if log file is open and can be written to.
Top
Methods
  NameDescription
Public methodAddAdditionalLine
Add an additional line to the log file. This line is related to a previous line added by AddLine(DiagnosticsHandlerMessageType, String), and type of error message and date/time will not be printed.
Public methodAddLine
Add a message line to the log file.
Public methodCloseLogFile
Close the logfile
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodStatic memberExceptionToConsole
Helper method that writes exception to console out (for command line output)
Public methodExceptionToLogFile
Prints exception message and stack to log file, including inner exceptions.
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 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.)
Public methodPrepare
Prepare (open) the log file. Returns false if the log file is already open, i.e. it can be called multiple times.
Public methodReportMike1DVersionToLogFile
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also