IDfsFileBuilder Interface |
See DfsBuilder for details
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)
SyntaxThe IDfsFileBuilder type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | DeleteValueByte |
Gets/sets the delete value of type byte
This is a stage 1 method. |
| DeleteValueDouble |
Gets/sets the delete value of type double
This is a stage 1 method. |
| DeleteValueFloat |
Gets/sets the delete value of type float
This is a stage 1 method. |
| DeleteValueInt |
Gets/sets the delete value of type int
This is a stage 1 method. |
| DeleteValueUnsignedInt |
Gets/sets the delete value of type unsigned int
This is a stage 1 method. |
Methods| Name | Description | |
|---|---|---|
 | AddCustomBlock(IDfsCustomBlock) |
Adds a custom block.
|
| AddCustomBlock(String, Array) |
Adds a custom block containing the array data.
The type of arrayData must be an array of type equivalent to one of the supported DfsSimpleType, e.g. int[]. |
| AddCustomBlock(String, Byte) |
Add a custom block containing byte data.
|
| AddCustomBlock(String, Double) |
Add a custom block containing double data.
|
| AddCustomBlock(String, Int16) |
Add a custom block containing short data.
|
| AddCustomBlock(String, Int32) |
Add a custom block containing int data.
|
| AddCustomBlock(String, Single) |
Add a custom block containing float data.
|
| AddCustomBlock(String, UInt16) |
Add a custom block containing ushort data.
|
| AddCustomBlock(String, UInt32) |
Add a custom block containing uint data.
|
| AddDynamicItem |
Add a dynamic item to the file.
|
| AddStaticItem(IDfsStaticItem) |
Add static item to the file.
The static item can come from another file, then the item definition and data is copied over. |
| AddStaticItem(String, Array) |
Creates and adds a static item storing the arrayData.
Use this only when Quantity
and SpatialAxis and others are
not important. Quantity and spatial axis are set to default
dummy values.
The type of arrayData must be an array of type equivalent to one of the supported DfsSimpleType, e.g. int[]. |
| AddStaticItem(String, eumQuantity, Array) |
Creates and adds a static item storing the arrayData.
Use this only when SpatialAxis is
not important. Spatial axis are set to default dummy values.
The type of arrayData must be an array of type equivalent to one of the supported DfsSimpleType, e.g. int[]. |
| CreateDynamicItemBuilder |
Create a dynamic item builder, for creating and configuring a new dynamic item.
|
| CreateFile |
Create the file and move from stage 1 to stage 2 of the build process.
|
| CreateStaticItemBuilder |
Create a static item builder, for creating and configuring a new static item.
|
| GetFile |
Returns the new dfs file
|
| SetApplicationTitle |
Set the title of the application writing the file.
This is a stage 1 method. |
| SetApplicationVersionNo |
Set the version number of the application writing the file.
This is a stage 1 method. |
| SetDataType |
Set the data type.
This is a stage 1 method. 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. |
| SetEncodingKey |
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., xKey[i] < xCount && yKey[y] < yCount && zKey[i] < zCount |
| SetFileTitle |
Set the title of the file.
This is a stage 1 method. |
| SetGeographicalProjection |
Sets the geographical projection and reference coordinates.
This must be set. This is a stage 1 method. |
| SetItemStatisticsType |
Sets the statistics level StatType of all items
in the file
This is a stage 1 method. |
| 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. |
| SetTemporalAxis |
Sets the temporal axis of the file.
This must be set. This is a stage 1 method. |
| 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. |
| Validate |
Validate will return a string of issues from the item builder.
When this returns an empty list, the item has been properly build.
|
See Also