DfsuFile Class

Class for exposing data from a dfsu file.

Use the DfsFileFactory to open an existing dfsu file.

Use the DfsuBuilder to create a new dfsu file.

You can read, write and append item-timesteps to the file.

The geometry can be altered, by moving the nodes, but the element connectivity can not be changed.

Inheritance Hierarchy

SystemObject
DHI.Generic.MikeZero.DFS.dfsuDfsuFile

Namespace: 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)

Syntax

C++

Copy

public class DfsuFile : IDfsuFile, IDfsFileIO, 
	IDisposable, IDfsFile, IDfsFileStaticIO

Public Class DfsuFile
	Implements IDfsuFile, IDfsFileIO, IDisposable, IDfsFile, 
	IDfsFileStaticIO

public ref class DfsuFile : IDfsuFile, 
	IDfsFileIO, IDisposable, IDfsFile, IDfsFileStaticIO

type DfsuFile =  
    class
        interface IDfsuFile
        interface IDfsFileIO
        interface IDisposable
        interface IDfsFile
        interface IDfsFileStaticIO
    end

The DfsuFile type exposes the following members.

Constructors

	Name	Description
	DfsuFile	Wrap a dfs file in the DfsuFile object. It will throw an exception if file is not a dfsu file.

Top

Properties

	Name	Description
	ApplicationTitle	Title of application creating the file
	ApplicationVersion	Version number of appliation creating the file.
	Code	Boundary code of node. 0 means not a boundary node.
	DeleteValueFloat	Delete (undefined/missing) value
	DfsuFileType	Type of dfsu file.
	ElementIds	Id for each element. Usually starts from 1 and increases, but needs not to.
	ElementTable	The ElementTable defines for each element which nodes that defines the element. The numbers in the ElementTable are node numbers, not indices! Each value in the table are between 1 and number-of-nodes.
	ElementType	Type of element.
	FileName	Name of file
	FileTitle	Title of file
	ItemInfo	List of dynamic item info.
	NodeIds	Id for each node. Usually starts from 1 and increases, but needs not to.
	NumberOfElements	Number of elements in the mesh.
	NumberOfLayers	For files with a vertical dimension, returns the maximum number of layers.
	NumberOfNodes	Number of nodes in the mesh.
	NumberOfSigmaLayers	For files with a vertical dimension, returns the number of sigma layers.
	NumberOfTimeSteps	Number of time steps in the file
	Projection	Geographical projection.
	StartDateTime	Start date time of the file. If time axis is not a calendar type axis, MinValue is returned. Setting the StartDateTime for an axis that is not of calendar type, will throw an exception.
	TimeAxis	Temporal axis of dfsu file.
	TimeStepInSeconds	Time step in seconds. If time axis is not an equidistant type axis, zero is returned. Setting the time step for an axis that is not of equidistant type, will throw an exception.
	X	X coordinates of nodes
	Y	Y coordinates of nodes
	Z	Z coordinates of nodes
	ZUnit	Unit of the z coordinate. The unit must be a length unit (convertable to meters).

Top

Methods

	Name	Description
	Close	See Close for details
	DfsCurrentVersion	Returns the current version of the Dfs file library
	Dispose	Close file and release ressources on the unmanaged side.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	FindItem	Positions the file pointer at the location in the file where the specified dynamic item at the specified time step starts.
	FindTimeStep	Positions the file pointer at the location in the file where the specified time step starts.
	Flush	See Flush for details
	FlushTimeStep	See FlushTimeStep
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Open(Stream)	Open a dfsu stream for reading
	Open(String)	Open a dfsu file for reading
	OpenAppend	Open a dfsu file for appending/editing. File pointer is pointing to the end of the file data.
	OpenEdit	Open a dfsu file for editing. File pointer is pointing to the start of the file data.
	ReadItemTimeStep(Int32, Int32)	See ReadItemTimeStep(Int32, Int32) for details
	ReadItemTimeStep(IDfsItemData, Int32)	See ReadItemTimeStep(IDfsItemData, Int32) for details
	ReadItemTimeStepNext	See ReadItemTimeStepNext for details
	Reset	Resets the file pointer to point on the first dynamic item time step in the file. Can also be used if it is required to restart reading the static items.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WriteItemTimeStep	Writes data to the specified item and timestep in the file. If the item-timestep exists already, data is updated. If it does not exist, the item number and timestep index must match exactly the next item-timestep after the last one in the file. The size of the data must match the data size of the item that is to be written. The time value is only relevant for files with non-equidistant time axis. For files with an equidistant time axis, the time value is ignored, and a zero can be used.
	WriteItemTimeStepNext	Writes the next dynamic item-timestep. If the file pointer points to the end of the file, this will append a new item-timestep to the file. If the file pointer points to an existing item-timestep, the data of that item-timestep is updated. Remember that the file pointer position depends on the mode that the file was opened: In edit mode the file pointer points at the first item-timestep. In append mode the file pointer points initially at the end of file. It iterates over the item-timesteps as the ReadItemTimeStepNext, see there for more details. This is the most efficient way to iterate through and update/append the items and timesteps in a file, since it iterates exactly as the data is stored on the disk. The size of the data must match the data size of the item that is to be written. The time value is only relevant for files with non-equidistant time axis. For files with an equidistant time axis, the time value is ignored, and a zero can be used.

Top

Extension Methods

	Name	Description
	CalculateElementCenterCoordinates	For each element, calculates the element center coordinate as the average of all node coordinates of the nodes in each element. (Defined by DfsuUtil.)
	CreateEmptyItemData(Int32)	Overloaded. Create an IDfsItemDataT of the correct type for the item with the given itemNumber. The result can be used by ReadItemTimeStep(IDfsItemData, Int32) (Defined by DfsExtensions.)
	CreateEmptyItemDataT(Int32)	Overloaded. Create an IDfsItemDataT of the correct type for the item with the given itemNumber. The result can be used by ReadItemTimeStep(IDfsItemData, Int32) If not the item is of type {T}, an exception will be thrown. (Defined by DfsExtensions.)
	CreateEmptyItemDatas	Overloaded. Create an IDfsItemDataT of the correct type for each of the dynamic items in the file. The result can be used by ReadItemTimeStep(IDfsItemData, Int32) (Defined by DfsExtensions.)
	CreateEmptyItemDatasT	Overloaded. Create an IDfsItemDataT of the provided type for each of the dynamic items in the file. The result can be used by ReadItemTimeStep(IDfsItemData, Int32) If not all items are of type {T}, an exception will be thrown. (Defined by DfsuUtil.)
	CreateEmptyItemDatasT	Overloaded. Create an IDfsItemDataT of the provided type for each of the dynamic items in the file. The result can be used by ReadItemTimeStep(IDfsItemData, Int32) If not all items are of type {T}, an exception will be thrown. (Defined by DfsExtensions.)
	FindTopLayerElements	Find element indices (zero-based) of the elements being the upper-most element in its column. Each column is identified by matching node id numbers. For 3D elements the last half of the node numbers of the bottom element must match the first half of the node numbers in the top element. For 2D vertical elements the order of the node numbers in the bottom element (last half number of nodes) are reversed compared to those in the top element (first half number of nodes). (Defined by DfsuUtil.)
	GetDateTimes	Return an array of DateTimes which are the times for each timestep (Defined by DfsuUtil.)
	Search(DateTime)	Overloaded. Searches the dfs file for the time step index of a time, and returns the zero-based time step index. The time axis of the file must be a calendar type time axis NOTE: For the non-equidistant time axes, the metod will read the first item in the file for a number of timesteps in random order, performing a binary search in the file data on disc. This will be slow if used many times on the same file. In such a case, use the lazy version of GetDateTimes(IDfsFile, Boolean) or GetDateTimes(IDfsFile, DateTime, Boolean). For the equidistant time axis, the method will calculate the time step index directly without reading data from the file. (Defined by DfsExtensions.)
	Search(Double)	Overloaded. Searches the dfs file for the time step index of a time, and returns the zero-based time step index. NOTE: For the non-equidistant time axes, the metod will read the first item in the file for a number of timesteps in random order, performing a binary search in the file data on disc. This will be slow if used many times on the same file. In such a case, use the lazy version of GetDateTimes(IDfsFile, Boolean) or GetDateTimes(IDfsFile, DateTime, Boolean). For the equidistant time axis, the method will calculate the time step index directly without reading data from the file. (Defined by DfsExtensions.)

Top

Reference

DHI.Generic.MikeZero.DFS.dfsu Namespace