DiagnosticsValue Class

A diagnostics value class. A diagnostics value contains a value and a type

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 DiagnosticsValue
Inheritance
Object    DiagnosticsValue

Constructors

DiagnosticsValue(Double) Construct a value with the specified double as value
DiagnosticsValue(Int32) Construct a value with the specified integer as value
DiagnosticsValue(String) Construct a value with the specified string as value
DiagnosticsValue(Double, eumItem) Construct a value with the specified eum item type
DiagnosticsValue(Double, eumQuantity) Construct a value with the specified eum item type

Properties

AsString Return value as a string in user units.

Uses global (static) unit system (UnitProvider) to convert to user units. To use local user units, use the version with the IUnitProvider argument.

Description Description of this value. Used as a headline for displaying values in a table
NoQuotes Flag specifying not to use quotes for string type diagnostics values.
Quantity Type of value attached to a diagnostic value. Mostly only relevant for double values.
UserUnitAsString User unit as a string

Uses global (static) unit system (UnitProvider) to convert to user units. To use local user units, use the version with the IUnitProvider argument.

Value Numerical value attached to a diagnostic value.
ValueInt Integer value attached to a diagnostic value.
ValueString String value attached to a diagnostic value.
ValueType Type of value stored

Methods

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)
GetAsStringWithUnit Return value as a with unit, in units defined by unitProvider
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetUserUnitAsString User unit as a string
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Overrides ObjectToString)

Fields

_quantity Type of value attached to a diagnostic value. Mostly only relevant for double values.
_stringValue String value attached to a diagnostic value.
_value Numerical value attached to a diagnostic value.
_valueInt Integer value attached to a diagnostic value.
Token Token to substitute out of diagnostics string when inserting this value. Default is {0}, {1} etc.

See Also