IDfs2Builder Interface

Builder for dfs2 files.

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

Syntax

C++

Copy

public interface IDfs2Builder : IDfs123Builder

Public Interface IDfs2Builder
	Inherits IDfs123Builder

public interface class IDfs2Builder : IDfs123Builder

type IDfs2Builder =  
    interface
        interface IDfs123Builder
    end

The IDfs2Builder 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. (Inherited from IDfs123Builder.)
	ApplicationVersion	Set the version number of the application writing the file. This is a stage 1 method. Setting in stage 2 has no effect. (Inherited from IDfs123Builder.)
	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. (Inherited from IDfs123Builder.)
	DeleteValueByte	Gets/sets the delete value of type byte This is a stage 1 method. Setting in stage 2 has no effect. (Inherited from IDfs123Builder.)
	DeleteValueDouble	Gets/sets the delete value of type double This is a stage 1 method. Setting in stage 2 has no effect. (Inherited from IDfs123Builder.)
	DeleteValueFloat	Gets/sets the delete value of type float This is a stage 1 method. Setting in stage 2 has no effect. (Inherited from IDfs123Builder.)
	DeleteValueInt	Gets/sets the delete value of type int This is a stage 1 method. Setting in stage 2 has no effect. (Inherited from IDfs123Builder.)
	DeleteValueUnsignedInt	Gets/sets the delete value of type unsigned int This is a stage 1 method. Setting in stage 2 has no effect. (Inherited from IDfs123Builder.)
	FileTitle	Get/Set the title of the file. This is a stage 1 method. Setting in stage 2 has no effect. (Inherited from IDfs123Builder.)
	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. (Inherited from IDfs123Builder.)
	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. (Inherited from IDfs123Builder.)
	TemporalAxis	Sets the temporal axis of the file. This must be set. This is a stage 1 method. Setting in stage 2 will fail. (Inherited from IDfs123Builder.)

Top

Methods

	Name	Description
	AddCustomBlock	Add a custom block to the file. This is a stage 1 method. (Inherited from IDfs123Builder.)
	AddDynamicItem	Add a dynamic item to the file. (Inherited from IDfs123Builder.)
	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. (Inherited from IDfs123Builder.)
	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. (Inherited from IDfs123Builder.)
	CreateFile	Creates a file on the disc. Moves to the second build stage (Inherited from IDfs123Builder.)
	CreateStream	Creates a file in the provided stream.. Moves to the second build stage (Inherited from IDfs123Builder.)
	GetFile	Return the file as a Dfs1File
	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. (Inherited from IDfs123Builder.)
	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 (Inherited from IDfs123Builder.)
	SetGeographicalProjection	Set the geographical projection and reference coordinates. This must be set. This is a stage 1 method. Setting in stage 2 will fail. (Inherited from IDfs123Builder.)
	SetNumberOfTimeSteps	Sets the number of time steps in the file. This is only required in streaming context, where it is not possible to update the dfs header when everything is written to the file. In a non-streaming context this should not be used. This is a stage 1 method. (Inherited from IDfs123Builder.)
	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. (Inherited from IDfs123Builder.)
	SetTemporalAxis	Sets the temporal axis of the file. This must be set. This is a stage 1 method. Setting in stage 2 will fail. (Inherited from IDfs123Builder.)
	SetTimeInfo	Sets the time of the first data set and the time span of data in the file. This is only required in streaming context, where it is not possible to update the dfs header when everything is written to the file. In a non-streaming context this should not be used. This is a stage 1 method. (Inherited from IDfs123Builder.)
	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. (Inherited from IDfs123Builder.)

Top

Reference

DHI.Generic.MikeZero.DFS.dfs123 Namespace