IDfsFileInfo Interface

Title of the application that wrote the file

When setting, the new string must match the length of the existing string. If the new string is shorter, spaces are appended, if the new string is longer, it is truncated.

Version of the application that wrote the file.

List of all custom blocks stored in the header, ordered as they where read from the file.

Type of data stored in the file.

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.

Delete value for type byte

Delete value for type double

Delete value for type float

Delete value for type int

Delete value for type unsigned int (uint)

Return the name of the file that was used to open/create the file.

Title of the file. Can be empty string.

When setting, the new string must match the length of the existing string. If the new string is shorter, spaces are appended, if the new string is longer, it is truncated.

Type of dfs file.

Returns true if the file is compressed. Use the GetEncodeKey(Int32, Int32, Int32) to get the compression encoding key.

Projection defining the coordinate system that is stored. All coordinates are stored in this projection.

Type of statistics stored in the header for each dynamic item.

Temporal axis of the file.

Gets the compression encoding key.

When a file is compressed, all dynamic items are compressed with the same encoding key, and hence also all dynamic items have the same spatial axis.

When a file is compressed, the encoding key defines for each value stored in the file the indices [xi, yi, zy] in the data matrix where the value belongs. Hence, the i'th data value belongs in the data matrix on Data[ xKey[i], yKey[i], zKey[i]], or using linear indexing: Data[xKey[i] + yKey[i]*xCount + zKey[i]*xCount*yCount].

For a 2D axis all zKey values are zero. For a 1D axis all yKey and zKey values are zero.

When reading data from dynamic items, data is automatically uncompressed when loaded, hence the encoding keys are only for information. Some files also compresses static items, and compresses these also, however using a dummy axis of the size of the encoding key, and manual decoding needs to take place, see dfsDecodeT(T, Int32, Int32, Int32, Int32, Int32, Int32, T) and dfsEncodeT(T, Int32, Int32, Int32, Int32, Int32, Int32).

Data outside the encoding key gets the delete value.

For a file with 2D data all zi's are zero, and for a 1D file, zi's and yi's are zero.

It is only valid to call this function if IsFileCompressed returns true.