DfsuBuilder Class |
The following must be set before calling CreateFile(String): SetProjection(IDfsProjection), SetTimeInfo(DateTime, Double), SetNodes(Double, Double, Single, Int32), SetElements(Int32).
For files with a vertical dimension, the SetNumberOfSigmaLayers(Int32) must also be set.
Other setters are optional, and if not set, default values are written to the file.
Using the SetFromMeshFile(MeshFile) will set the projection, nodes and elements from the mesh file.
Be aware; setting the node and element id's to anything but the default values can cause some tools to fail.
Inheritance HierarchyNamespace: DHI.Generic.MikeZero.DFS.dfsu
Assembly: DHI.Generic.MIKEZero.DFS (in DHI.Generic.MIKEZero.DFS.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe DfsuBuilder type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ApplicationTitle |
Get/Set the title of the application writing the file.
|
| ApplicationVersion |
Set the version number of the application writing the file.
|
| FileTitle |
Get/Set the title of the file.
|
Methods| Name | Description | |
|---|---|---|
 | AddDynamicItem |
Add a dynamic item.
|
 | Create |
Create a new dfsu builder
|
| CreateFile |
Create and return a dfsu file
|
| CreateStream |
Create and return a dfsu file, writing content to stream
|
| 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.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| SetElementIds |
Set the element id's. Optional. If not set, default values are used (1,2,3,...)
|
| SetElements |
Set element connectivity: For each element is specified which nodes
the element consist of. The node is specified by its index into the list of nodes.
|
| SetFromMeshFile |
Set projection, nodes and elements from mesh file.
This is equivalent to calling SetProjection(IDfsProjection), SetNodes(Double, Double, Single, Int32), SetElements(Int32). |
| SetNodeIds |
Set the node id's. Optional. If not set, default values are used (1,2,3,...)
|
| SetNodes(Double, Double, Single, Int32) |
Set node coordinates and code. Depending on the projection string,
node coordinates are in meters or degrees.
|
| SetNodes(Single, Single, Single, Int32) | Obsolete.
Set node coordinates and code. Depending on the projection string,
node coordinates are in meters or degrees.
|
| SetNumberOfSigmaLayers |
Set the number of sigma layers in a file with a vertical dimension
|
| 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. |
| SetProjection |
Set the geographical projection
|
| SetTemporalAxis |
Set a non-standard temporal axis for the dfsu file. WARNING: The dfsu file will not be valid in all contexts.
The standard dfsu file requires an IDfsEqCalendarAxis temporal axis. You can use the SetTimeInfo(DateTime, Double) method to define a valid IDfsEqCalendarAxis axis for the dfsu file. If you define another temporal axis than the IDfsEqCalendarAxis for a dfsu file, be sure to test that the file works as intended in your context. |
| SetTimeInfo |
Set time info, specifying an equidistant calendar axis, which is the default (always valid) temporal axis of a dfsu file.
|
| SetZUnit |
Set unit of the z coordinate. By default the unit is meters, but
the unit can be overridden by setting it explicitly here. The unit
must be a length unit (convertable to meters).
|
| 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.
|
See Also