DfsuFile Methods |
The DfsuFile type exposes the following members.
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. |
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.
(Defined by DfsExtensions.)The result can be used by ReadItemTimeStep(IDfsItemData, Int32) |
![]() | CreateEmptyItemDataT(Int32) | Overloaded.
Create an IDfsItemDataT of the correct type for the
item with the given itemNumber.
(Defined by DfsExtensions.)The result can be used by ReadItemTimeStep(IDfsItemData, Int32) If not the item is of type {T}, an exception will be thrown. |
![]() | CreateEmptyItemDatas | Overloaded.
Create an IDfsItemDataT of the correct type for each of the
dynamic items in the file.
(Defined by DfsExtensions.)The result can be used by ReadItemTimeStep(IDfsItemData, Int32) |
![]() | CreateEmptyItemDatasT | Overloaded.
Create an IDfsItemDataT of the provided type for each of the
dynamic items in the file.
(Defined by DfsuUtil.)The result can be used by ReadItemTimeStep(IDfsItemData, Int32) If not all items are of type {T}, an exception will be thrown. |
![]() | CreateEmptyItemDatasT | Overloaded.
Create an IDfsItemDataT of the provided type for each of the
dynamic items in the file.
(Defined by DfsExtensions.)The result can be used by ReadItemTimeStep(IDfsItemData, Int32) If not all items are of type {T}, an exception will be thrown. |
![]() | FindTopLayerElements |
Find element indices (zero-based) of the elements being the upper-most element
in its column.
(Defined by DfsuUtil.)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). |
![]() | 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
(Defined by DfsExtensions.)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. |
![]() | Search(Double) | Overloaded.
Searches the dfs file for the time step index of a time,
and returns the zero-based time step index.
(Defined by DfsExtensions.)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. |