DiagnosticItemID Class

One single diagnostics item/issue, containing one message, based on the MIKE 1D fixed set of messages (resource-based).

A message can have a number of DiagnosticsValue attached, giving a number and a item type. The unit is always the default unit of the type (SI).

Definition

Namespace: DHI.Mike1D.Generic
Assembly: DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class DiagnosticItemID : DiagnosticItem, 
	IDiagnosticItem
Inheritance
Object    DiagnosticItem    DiagnosticItemID
Implements
IDiagnosticItem

Constructors

DiagnosticItemID(String) Create diagnostic item without values
DiagnosticItemID(String, ListDiagnosticsValue) Create diagnostic item with list of values
DiagnosticItemID(String, Object) Create diagnostic item with list of values

Properties

AdditionalInfo Additional information about diagnostics item. Used to append time step information to errors in HDModule.
(Inherited from DiagnosticItem)
Diagnostics The diagnostics that the item belongs to.

This is automatically set when item is added to diagnostics object.


(Inherited from DiagnosticItem)
Hint Diagnostics hint
(Overrides DiagnosticItemHint)
Location Location of message
(Inherited from DiagnosticItem)
Message Diagnostics message with value placeholders replaced by values. Value place holder can be modified by setting the Tokens.
(Inherited from DiagnosticItem)
MessageID ID of error in item.

Each kind of error will have an id which does not change between computers. The Message change, if localized messages exist for the system language.


(Overrides DiagnosticItemMessageID)
MessageNoValues Diagnostics message
(Overrides DiagnosticItemMessageNoValues)
Tokens Set tokens for each of the Values. Defaults to {0}, {1}, {2} etc
(Inherited from DiagnosticItem)
Values Diagnostic values
(Inherited from DiagnosticItem)

Methods

CheckNumberOfValues Check if number of diagnostic values matches number of brackets
(Inherited from DiagnosticItem)
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)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetMessage Diagnostics message with value placeholders replaced by values. Value place holder can be modified by setting the Tokens.
(Inherited from DiagnosticItem)
GetTypeGets the Type of the current instance.
(Inherited from Object)
HandleValues Examine each arg and put it into an appropriate diagnostic value
(Inherited from DiagnosticItem)
HasHint Returns true if this item has an associated hint. The hint can be accessed throught the Hint property.
(Overrides DiagnosticItemHasHint)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
NumberOfValues Return the number of values that this item expects
(Inherited from DiagnosticItem)
SetLocation(String) Location of error message
(Inherited from DiagnosticItem)
SetLocation(DiagnosticsLocationType, String) Location of error message
(Inherited from DiagnosticItem)
SetLocation(String, Double) Location of error message
(Inherited from DiagnosticItem)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Fields

_location Location where item was generated
(Inherited from DiagnosticItem)
_message Actual message
(Inherited from DiagnosticItem)
_messageId ID of message
(Inherited from DiagnosticItem)
_values Values associated with item
(Inherited from DiagnosticItem)

See Also