Click or drag to resize

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).

Inheritance Hierarchy

Namespace:  DHI.Mike1D.Generic
Assembly:  DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class DiagnosticItemID : DiagnosticItem, 
	IDiagnosticItem

The DiagnosticItemID type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAdditionalInfo
Additional information about diagnostics item. Used to append time step information to errors in HDModule.
(Inherited from DiagnosticItem.)
Public propertyDiagnostics
The diagnostics that the item belongs to.

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

(Inherited from DiagnosticItem.)
Public propertyHint
Diagnostics hint
(Overrides DiagnosticItemHint.)
Public propertyLocation
Location of message
(Inherited from DiagnosticItem.)
Public propertyMessage
Diagnostics message with value placeholders replaced by values. Value place holder can be modified by setting the Tokens.
(Inherited from DiagnosticItem.)
Public propertyMessageID
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.)
Public propertyMessageNoValues
Diagnostics message
(Overrides DiagnosticItemMessageNoValues.)
Public propertyTokens
Set tokens for each of the Values. Defaults to {0}, {1}, {2} etc
(Inherited from DiagnosticItem.)
Public propertyValues
Diagnostic values
(Inherited from DiagnosticItem.)
Top
Methods
  NameDescription
Protected methodCheckNumberOfValues
Check if number of diagnostic values matches number of brackets
(Inherited from DiagnosticItem.)
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHandleValues
Examine each arg and put it into an appropriate diagnostic value
(Inherited from DiagnosticItem.)
Public methodHasHint
Returns true if this item has an associated hint. The hint can be accessed throught the Hint property.
(Overrides DiagnosticItemHasHint.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNumberOfValues
Return the number of values that this item expects
(Inherited from DiagnosticItem.)
Public methodSetLocation(String)
Location of error message
(Inherited from DiagnosticItem.)
Public methodSetLocation(String, Double)
Location of error message
(Inherited from DiagnosticItem.)
Public methodSetLocation(DiagnosticsLocationType, String)
Location of error message
(Inherited from DiagnosticItem.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Protected field_location
Location where item was generated
(Inherited from DiagnosticItem.)
Protected field_message
Actual message
(Inherited from DiagnosticItem.)
Protected field_messageId
ID of message
(Inherited from DiagnosticItem.)
Protected field_values
Values associated with item
(Inherited from DiagnosticItem.)
Top
See Also