Click or drag to resize

DfsDynamicItemBuilder Class

Builder to configure an existing dynamic item structure.

The following functions must be set: Set(String, eumQuantity, DfsSimpleType), SetAxis(IDfsSpatialAxis), SetValueType(DataValueType).

Inheritance Hierarchy

Namespace:  DHI.Generic.MikeZero.DFS
Assembly:  DHI.Generic.MIKEZero.DFS (in DHI.Generic.MIKEZero.DFS.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class DfsDynamicItemBuilder : DfsAbstractItemBuilder

The DfsDynamicItemBuilder type exposes the following members.

Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetDynamicItemInfo
Gets the newly created dynamic item info

It does call Validate, and if validate returns any issues, this method will throw an exception.

Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSet
Sets name, eum quantity and item data type.

This must be set.

(Inherited from DfsAbstractItemBuilder.)
Public methodSetAssociatedStaticItem
Associate a static item with this dynamic item.
Public methodSetAxis
Sets the spatial axis.

This must be set.

(Inherited from DfsAbstractItemBuilder.)
Public methodSetAxisUnitConversion
Sets the unit conversion for the axis of the item.

Optional. The default for an item is that no conversion is performed.

If it's set to anything else than no conversion, automatic conversion is performed.

(Inherited from DfsAbstractItemBuilder.)
Public methodSetOrientation
Sets reference orientation.

Optional. If not set, default values of 0 are used.

(Inherited from DfsAbstractItemBuilder.)
Public methodSetReferenceCoordinates
Sets reference coordinates.

Optional. If not set, default values of 0 are used.

(Inherited from DfsAbstractItemBuilder.)
Public methodSetUnitConversion
Sets the unit conversion for item.

Optional. The default for an item is that no conversion is performed.

If it's set to anything else than no conversion, automatic conversion is performed.

(Inherited from DfsAbstractItemBuilder.)
Public methodSetValueType
Sets the time value type for the item.

This must be set.

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate
Validate will return a string of issues from the item builder. When this returns an empty list, the item has been properly build.
(Overrides DfsAbstractItemBuilderValidate.)
Top
Remarks
This configures an existing dynamic item that has not yet been written to file, i.e., length of strings can be changed.
See Also