Click or drag to resize
DfsuFile Methods

The DfsuFile type exposes the following members.

Methods
  NameDescription
Public methodClose
Public methodDispose
Close file and release ressources on the unmanaged side.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFindItem
Positions the file pointer at the location in the file where the specified dynamic item at the specified time step starts.
Public methodFindTimeStep
Positions the file pointer at the location in the file where the specified time step starts.
Public methodFlush
Public methodFlushTimeStep
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberOpen
Open a dfsu file for reading
Public methodStatic memberOpenAppend
Open a dfsu file for appending/editing. File pointer is pointing to the end of the file data.
Public methodStatic memberOpenEdit
Open a dfsu file for editing. File pointer is pointing to the start of the file data.
Public methodReadItemTimeStep(Int32, Int32)
Public methodReadItemTimeStep(IDfsItemData, Int32)
Public methodReadItemTimeStepNext
Public methodReset
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.

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWriteItemTimeStep
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.

Public methodWriteItemTimeStepNext

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
  NameDescription
Public Extension MethodCalculateElementCenterCoordinates
For each element, calculates the element center coordinate as the average of all node coordinates of the nodes in each element.
(Defined by DfsuUtil.)
Public Extension MethodFindTopLayerElements
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.)
Public Extension MethodGetDateTimes
Return an array of DateTimes which are the times for each timestep
(Defined by DfsuUtil.)
Top
See Also