.Modelica.Utilities.Streams.writeRealMatrix

Information

Syntax

success = Streams.writeRealMatrix(fileName, matrixName, matrix, append, format)

Description

Function writeRealMatrix(..) writes the given matrix to a new or an existing MATLAB MAT file (in format v4, v6, v7, and if HDF is supported in the Modelica tool, also v7.3). If append = false (= default), the file is newly created (or an existing file is deleted and re-created). If append = true, the matrix is included in an existing file or if the file does not yet exists this flag is ignored. If the file exists and append = true, argument format is ignored.

Parameter format defines the format in which the values are stored on file. The following formats are supported:
 

The function returns success = true if the matrix was successfully written to file. Otherwise, an error message is printed and the function returns with success = false.

Example

See Examples.WriteRealMatrixToFile.

See also

readMatrixSize, readRealMatrix

Interface

impure function writeRealMatrix
  extends Modelica.Icons.Function;
  input String fileName "File where external data is to be stored" annotation(
    Dialog(saveSelector(filter = "MATLAB MAT files (*.mat)", caption = "Save MATLAB MAT file")));
  input String matrixName "Name / identifier of the 2D Real array on the file";
  input Real matrix[:, :] "2D Real array";
  input Boolean append = false "Append values to file";
  input String format = "4" "MATLAB MAT file version: \"4\" -> v4, \"6\" -> v6, \"7\" -> v7" annotation(
    choices(choice = "4" "MATLAB v4 MAT file", choice = "6" "MATLAB v6 MAT file", choice = "7" "MATLAB v7 MAT file"));
  output Boolean success "true if successful";
end writeRealMatrix;