Quantity Class |
The data item type is one of the EUM types
For AD components, they will usually have the same datatype but different ID's.
It is not allowed to edit an IQuantity. Create a new one, if required.
Inheritance HierarchyDHI.Mike1D.GenericQuantity
DHI.Mike1D.GenericSummedQuantity
DHI.Mike1D.ResultDataAccessLTSResultQuantity
Namespace: DHI.Mike1D.Generic
Assembly: DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe Quantity type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Quantity |
Default constructor, creates and undefined quantity.
COM requires empty constructor.
Afterwards use Create(eumItem, String, String)
to create the quantity.
|
| Quantity(eumItem, String) |
Construct data quantity from eumItem and description
|
| Quantity(eumQuantity, String) |
Construct data quantity from eumItem and description
|
| Quantity(String, String, eumItem) |
Construct data quantity from eumItem and description
|
| Quantity(String, String, eumItem, eumUnit) |
Construct data quantity from eumItem and description
|
Properties| Name | Description | |
|---|---|---|
 | Description |
Quantity description
|
| EumQuantity |
EumQuantity (item type and unit)
|
| Id |
ID of the quantity. The ID is unique for a specific type of quantity within MIKE 1D.
Two quantities with different Ids are not equal to each other.
|
| TimeValueType |
Type of value in time stored by the quantity.
|
 | Undefined |
Return a wuantity based on eumItem.eumIItemUndefined
|
Methods| Name | Description | |
|---|---|---|
| AppendNum |
Append the number in the id and description string of the quantity.
|
| AppendZoneNum |
Create zone quantity
This is used by the NAM model to create snow zone quantities. Append the number in the id (if larger than one) and prepend "Zone X" to description of quantity. If the description already contains "Zone", it is replaced by "Zone X" |
| ComparerDescription |
Provides a equality comparer that also includes the Description
in the comparison
|
| ComparerGroup |
Provides a equality comparer that groups quantities of the same type.
Quantities like SnowCover, SnowCover_2, SnowCover_3 are in this context grouped under one. |
| Create(PredefinedQuantity) |
Create a Quantity based on one of the PredefinedQuantity |
| Create(PredefinedQuantity, eumUnit) |
Create a Quantity based on one of the PredefinedQuantity |
| Create(PredefinedQuantity, String) |
Create a Quantity based on one of the PredefinedQuantity |
| Create(eumItem, String, String) |
Create a new Quantity. Not static for COM support.
|
| CreateVariable |
Create a quantity for control module variable
|
| Equals(Object) | (Overrides ObjectEquals(Object).) |
| Equals(IQuantity) |
Indicates whether the current object is equal to another object of the same type.
|
| Equals(IQuantity, IQuantity) |
Equals method on BaseId, which is the Id with commas and spaces removed.
|
| EqualsBaseId |
Equals method on BaseId, which is the Id with commas and spaces removed.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode |
Serves as a hash function for a particular type.
(Overrides ObjectGetHashCode.) |
| GetHashCode(IQuantity) |
Serves as a hash function for this type. Uses the Id of the quantity as specified, but not the description.
|
| GetHashCodeBaseId |
Serves as a hash function based on Base Id.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GuessUnitFromString |
Try guess an eum unit from a string.
For this to work, be sure to use a string matching the Description ("Desc") of an eumUnit. If the string does not exactly any unit, a set of common abbreviations are tried. If no success, eumUUnitUndefined is returned. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PrependNum |
Prepend the number in the id string of the quantity.
|
| ToBaseId |
Converting a Quantity Id to its base form, without commas and spaces
|
| ToString |
Return eumItemType and description as a string
(Overrides ObjectToString.) |
See Also