IDfs123Builder Interface

Interface common for building a dfs 1, 2 or 3 file

Namespace: DHI.Generic.MikeZero.DFS.dfs123
Assembly: DHI.Generic.MikeZero.DFS (in DHI.Generic.MikeZero.DFS.dll) Version: 16.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public interface IDfs123Builder

Public Interface IDfs123Builder

public interface class IDfs123Builder

type IDfs123Builder =  interface end

The IDfs123Builder type exposes the following members.

Properties

	Name	Description
	ApplicationTitle	Get/Set the title of the application writing the file. This is a stage 1 method. Setting in stage 2 has no effect.
	ApplicationVersion	Set the version number of the application writing the file. This is a stage 1 method. Setting in stage 2 has no effect.
	DataType	Get/Set the data type. The data type tags the file as a special dfs file type. There exists no global system for maintaining these tag-variables. The tag-variables should only be interpreted locally within one model-complex e.g. MIKE 21. The application programmer can tag bathymetries, result files, input files freely. This is a stage 1 method. Setting in stage 2 will fail.
	DeleteValueByte	Gets/sets the delete value of type byte This is a stage 1 method. Setting in stage 2 has no effect.
	DeleteValueDouble	Gets/sets the delete value of type double This is a stage 1 method. Setting in stage 2 has no effect.
	DeleteValueFloat	Gets/sets the delete value of type float This is a stage 1 method. Setting in stage 2 has no effect.
	DeleteValueInt	Gets/sets the delete value of type int This is a stage 1 method. Setting in stage 2 has no effect.
	DeleteValueUnsignedInt	Gets/sets the delete value of type unsigned int This is a stage 1 method. Setting in stage 2 has no effect.
	FileTitle	Get/Set the title of the file. This is a stage 1 method. Setting in stage 2 has no effect.
	Projection	Get/Set the geographical projection and reference coordinates. This must be set. This is a stage 1 method. Setting in stage 2 will fail.
	SpatialAxis	Get/Set the spatial axis of the file. This must be one of the allowed axis, depending on the file builder This must be set. This is a stage 1 method. Setting in stage 2 will fail.
	TemporalAxis	Sets the temporal axis of the file. This must be set. This is a stage 1 method. Setting in stage 2 will fail.

Top

Methods

	Name	Description
	AddCustomBlock	Add a custom block to the file. This is a stage 1 method.
	AddDynamicItem	Add a dynamic item to the file.
	AddStaticItem(String, eumQuantity, Array)	Creates and adds a static item storing the arrayData. The size of the arrayData must match the size of the spatial axis set in SpatialAxis This is a stage 2 method.
	AddStaticItem(String, eumQuantity, IDfsSpatialAxis, Array)	Creates and adds a static item of a different size than the other items of the dfs file. Having a static item in size different from the dynamic items is utilized by a few specific files of MIKE SHE. The size of the arrayData must match the size of the spatial axis set in axis This is a stage 2 method.
	CreateFile	Creates a file on the disc. Moves to the second build stage
	SetDataType	Set the data type. The data type tags the file as a special dfs file type. There exists no global system for maintaining these tag-variables. The tag-variables should only be interpreted locally within one model-complex e.g. MIKE 21. The application programmer can tag bathymetries, result files, input files freely. This is a stage 1 method. Setting in stage 2 will fail.
	SetEncodingKeys	Sets the encoding key for compressing the dfs file. See GetEncodeKey(Int32, Int32, Int32) for the definition of the encode key values. Compression is only supported when all dynamic items are of type float. All dynamic items must have a size that is compatible with the encode key values, i.e, for all values in the key arrays: Copy xKey[i] < xCount && yKey[y] < yCount && zKey[i] < zCount
	SetGeographicalProjection	Set the geographical projection and reference coordinates. This must be set. This is a stage 1 method. Setting in stage 2 will fail.
	SetSpatialAxis	Get/Set the spatial axis of the file. This must be one of the allowed axis, depending on the file builder This must be set. This is a stage 1 method. Setting in stage 2 will fail.
	SetTemporalAxis	Sets the temporal axis of the file. This must be set. This is a stage 1 method. Setting in stage 2 will fail.
	Validate	Validate will return a string of issues from the item builder. When this returns an empty list, the item has been properly build. This is a stage 1 method.

Top

Reference

DHI.Generic.MikeZero.DFS.dfs123 Namespace