DfsStaticItemBuilder Class

Builder to configure an existing dynamic item structure.

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

Inheritance Hierarchy

SystemObject
DHI.Generic.MikeZero.DFSDfsAbstractItemBuilder
DHI.Generic.MikeZero.DFSDfsStaticItemBuilder

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

C++

Copy

public class DfsStaticItemBuilder : DfsAbstractItemBuilder

Public Class DfsStaticItemBuilder
	Inherits DfsAbstractItemBuilder

public ref class DfsStaticItemBuilder : public DfsAbstractItemBuilder

type DfsStaticItemBuilder =  
    class
        inherit DfsAbstractItemBuilder
    end

The DfsStaticItemBuilder type exposes the following members.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetStaticItem	Returns the static item. It does call Validate, and if validate returns any issues, this method will throw an exception.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Set	Sets name, eum quantity and item data type. This must be set. (Inherited from DfsAbstractItemBuilder.)
	SetAxis	Sets the spatial axis. This must be set. (Inherited from DfsAbstractItemBuilder.)
	SetAxisUnitConversion	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.)
	SetData	Sets the data array for the static item.
	SetOrientation	Sets reference orientation. Optional. If not set, default values of 0 are used. (Inherited from DfsAbstractItemBuilder.)
	SetReferenceCoordinates	Sets reference coordinates. Optional. If not set, default values of 0 are used. (Inherited from DfsAbstractItemBuilder.)
	SetUnitConversion	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.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Validate	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 creates a new static item when instantiated, but the item is not yet a part of the file. When GetStaticItem is called, a DfsStaticItemWrapper is returned that can be added to the DfsBuilder.

Reference

DHI.Generic.MikeZero.DFS Namespace