Basic Usage

At the moment, UFFFiles.jl only implements reading functionalities through the function readuff. Future versions will include additional functionalities for writing UFF data in a given format.

Reading UFF Files

using UFFFiles

data = readuff("path/to/your/file.uff")
readuff(filename::String) -> Vector{UFFDataset}

Reads a UFF (Universal File Format) file and parses its contents into a vector of UFFDataset objects.

Input

  • filename::String: The path to the UFF file to be read.

Output

  • data::Vector{UFFDataset}: A vector containing the parsed UFF datasets.

Because readuff returns a vector of datasets, you can interact with a given dataset as usually done in Julia. A dataset is a Julia composite type (i.e., a struct), having its own fields, corresponding to the UFF dataset type.

As an example, let’s say that you have read a UFF file containing multiple datasets. You can access each dataset by indexing the returned vector and interacting with it through its fields.

# Access to the first dataset extracted
# Suppose that the first dataset is of type Dataset15
d15 = data[1]

# Access to the list of node coordinates
node_coords = d15.coords