Dfs1File Class

Dfs1 file class

Use the DfsFileFactory to open an existing dfs1 file.

Use the Dfs1Builder to create a new dfs1 file.

Inheritance Hierarchy

SystemObject
DHI.Generic.MikeZero.DFS.dfs123Dfs123File
DHI.Generic.MikeZero.DFS.dfs123Dfs1File

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 class Dfs1File : Dfs123File, IDfs1File, 
	IDfs123File, IDfsFileIO, IDfsFileStaticIO, IDisposable

Public Class Dfs1File
	Inherits Dfs123File
	Implements IDfs1File, IDfs123File, IDfsFileIO, IDfsFileStaticIO, 
	IDisposable

public ref class Dfs1File : public Dfs123File, 
	IDfs1File, IDfs123File, IDfsFileIO, IDfsFileStaticIO, IDisposable

type Dfs1File =  
    class
        inherit Dfs123File
        interface IDfs1File
        interface IDfs123File
        interface IDfsFileIO
        interface IDfsFileStaticIO
        interface IDisposable
    end

The Dfs1File type exposes the following members.

Constructors

	Name	Description
	Dfs1File	Wrap a dfs file object in a dfs1 file object. If dfs file is not a dfs1 file, behavior is undefined.

Top

Properties

	Name	Description
	FileInfo	File info (Inherited from Dfs123File.)
	FileName	Name of file. (Inherited from Dfs123File.)
	ItemInfo	Information on all the dynamic items in the file. (Inherited from Dfs123File.)
	SpatialAxis	Spatial axis that are valid for all dynamic and static items. (Inherited from Dfs123File.)

Top

Methods

	Name	Description
	Close	See Close (Inherited from Dfs123File.)
	DfsCurrentVersion	Returns the current version of the Dfs file library (Inherited from Dfs123File.)
	Dispose	Close file and release ressources on the unmanaged side. (Inherited from Dfs123File.)
	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. (Inherited from Dfs123File.)
	FindTimeStep	Positions the file pointer at the location in the file where the specified time step starts. (Inherited from Dfs123File.)
	Flush	See Flush (Inherited from Dfs123File.)
	FlushTimeStep	See FlushTimeStep (Inherited from Dfs123File.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ReadItemTimeStep(Int32, Int32)	See ReadItemTimeStep(Int32, Int32)
	ReadItemTimeStep(IDfsItemData, Int32)	See ReadItemTimeStep(IDfsItemData, Int32)
	ReadItemTimeStepNext	See ReadItemTimeStepNext
	ReadStaticItem	See ReadStaticItem(Int32) (Inherited from Dfs123File.)
	ReadStaticItemNext	See ReadStaticItemNext (Inherited from Dfs123File.)
	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. (Inherited from Dfs123File.)
	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. (Inherited from Dfs123File.)
	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. (Inherited from Dfs123File.)
	WriteStaticItemData	See WriteStaticItemData(IDfsStaticItem, Array) (Inherited from Dfs123File.)

Top

Extension Methods

	Name	Description
	ReadFloatDataForItem	Read float data for the specified item and the specified time step indices. If itemnumber or one of the time step indices is out of range, an exception is thrown. (Defined by Dfs1Util.)

Top

Reference

DHI.Generic.MikeZero.DFS.dfs123 Namespace