Click or drag to resize

DfsFactory Class

Factory class for creating Dfs classes.

It contains functionality for creating classes that are to be used when building a new file, e.g. the DfsBuilder.

Inheritance Hierarchy
SystemObject
  DHI.Generic.MikeZero.DFSDfsFactory

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
public class DfsFactory

The DfsFactory type exposes the following members.

Constructors
  NameDescription
Public methodDfsFactory
Initializes a new instance of the DfsFactory class
Top
Methods
  NameDescription
Public methodCreateAxisCurveLinearD2
Create a 2D curve-linear spatial axis. See IDfsAxisCurveLinearD2 for details. This 2D axis is used for curve-linear dfs2 files.
Public methodCreateAxisCurveLinearD3
Create a 3D curve-linear spatial axis. See IDfsAxisCurveLinearD3 for details. This 3D axis is used for special types of dfs3 files.
Public methodCreateAxisDummy
Create a dummy spatial axis that can contain numberOfValues data values.

This can be used when an item does not have a relevant spatial axis and it is required to store a number of values. It is used for items of a dfsu file.

Public methodCreateAxisEqD0
Create a 0D spatial axis. This 0D axis is used for dfs0 files. See IDfsAxisEqD0 for details.
Public methodCreateAxisEqD1
Create a 1D equidistant spatial axis. This 1D axis is used for dfs1 files. See IDfsAxisEqD1 for details.
Public methodCreateAxisEqD2
Create a 2D equidistant spatial axis. This 2D axis is used for dfs2 files. See IDfsAxisEqD2 for details.
Public methodCreateAxisEqD3
Create a 3D equidistant spatial axis. This 3D axis is used for dfs3 files. See IDfsAxisEqD3 for details.
Public methodCreateAxisEqD4
Create a 4D equidistant spatial axis. Currently not supported.
Public methodCreateAxisNeqD1
Create a 1D non-equidistant spatial axis. This 1D axis is used for dfs1 files. See IDfsAxisNeqD1 for details.

This is actually more alike a 1D curve-linear axis.

Public methodCreateAxisNeqD2
Create a 2D non-equidistant spatial axis. This 2D axis is used for special types of dfs2 files. See IDfsAxisNeqD2 for details.
Public methodCreateAxisNeqD3
Create a 3D non-equidistant spatial axis. This 3D axis is used for special types of dfs3 files.
Public methodCreateCustomBlock(String, Array)
Create a custom block, with the provided name and data.

The arrayData must be an array of type float, double, byte, int, uint, short or ushort

Public methodCreateCustomBlockT(String, T)
Create a custom block, with the provided name and data.
Public methodCreateDfs1Builder
Create a Dfs2Builder for building a dfs1 file.
Public methodCreateDfs2Builder
Create a Dfs2Builder for building a dfs2 file.
Public methodCreateDfs3Builder
Create a Dfs2Builder for building a dfs3 file.
Public methodCreateDfsuBuilder
Create a Dfs2Builder for building a dfsu file.
Public methodCreateGenericDfsBuilder
Create a DfsBuilder for building a generic dfs file.
Public methodCreateMeshBuilder
Create a MeshBuilder for building a mesh file.
Public methodCreateProjection
Create an IDfsProjection based on the wktProjectionString.

The reference coordinates are set to the origin of the projected coordinate system.

Public methodCreateProjectionGeoOrigin
Create an IDfsProjection based on the wktProjectionString, and set the origin (in geo (lon-lat) coordinates) and orientation of the model coordinate system.

See IDfsProjection for details on the lon-lat origin and orientation.

Public methodCreateProjectionProjOrigin
Create an IDfsProjection based on the wktProjectionString, and set the origin (in projected coordinates) and orientation of the model coordinate system.

See IDfsProjection for details on the lon-lat origin and orientation.

The projection returned will store values as longitude, lattitude and orientation from true north.

Public methodCreateProjectionUndefined
Creates an undefined IDfsProjection which is provided for backward compatibility. Use preferably one of the other projection methods.
Public methodCreateStaticItem
Create a static item with the provided name, quantity and data.

data must an array with one of the supported DfsSimpleType, e.g. int[].

The spatial axis is set to a dummy axis of the correct length.

Public methodCreateTemporalEqCalendarAxis
Create a temporal axis, equidistant calendar axis.
Public methodCreateTemporalEqTimeAxis
Create a temporal axis, equidistant time axis.
Public methodCreateTemporalNonEqCalendarAxis
Create a temporal axis, non-equidistant calendar axis.
Public methodCreateTemporalNonEqTimeAxis
Create a temporal axis, non-equidistant time axis.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also