Package Modelica.Utilities.Internal.FileSystemInternal package with external functions as interface to the file system
Package Modelica.Utilities.Internal.FileSystem
Package Internal.FileSystem is an internal package that contains low level functions as interface to the file system. These functions should not be called directly in a scripting environment since more convenient functions are provided in packages Files and Systems.
Note, the functions in this package are direct interfaces to functions of POSIX and of the standard C library. Errors occurring in these functions are treated by triggering a Modelica assert. Therefore, the functions in this package return only for a successful operation. Furthermore, the representation of a string is hidden by this interface, especially if the operating system supports Unicode characters.
Extends from Modelica.Icons.InternalPackage (Icon for an internal package (indicating that the package should not be directly utilized by user)).
| Name | Description |
|---|---|
copyFile | Copy existing file (C functions 'fopen', 'getc', 'putc', 'fclose') |
getNumberOfFiles | Get number of files and directories in a directory (POSIX functions opendir, readdir, closedir) |
mkdir | Make directory (POSIX: 'mkdir') |
readDirectory | Read names of a directory (POSIX functions opendir, readdir, closedir) |
removeFile | Remove existing file (C function 'remove') |
rename | Rename existing file or directory (C function 'rename') |
rmdir | Remove empty directory (POSIX function 'rmdir') |
stat | Inquire file information (POSIX function 'stat') |
Function Modelica.Utilities.Internal.FileSystem.mkdir
This icon indicates Modelica functions.
Extends from Modelica.Icons.Function (Icon for functions).
| Type | Name | Description |
|---|---|---|
String | directoryName | Make a new directory |
Function Modelica.Utilities.Internal.FileSystem.rmdir
This icon indicates Modelica functions.
Extends from Modelica.Icons.Function (Icon for functions).
| Type | Name | Description |
|---|---|---|
String | directoryName | Empty directory to be removed |
Function Modelica.Utilities.Internal.FileSystem.stat
This icon indicates Modelica functions.
Extends from Modelica.Icons.Function (Icon for functions).
| Type | Name | Description |
|---|---|---|
String | name | Name of file, directory, pipe etc. |
| Type | Name | Description |
|---|---|---|
FileType | fileType | Type of file |
Function Modelica.Utilities.Internal.FileSystem.rename
This icon indicates Modelica functions.
Extends from Modelica.Icons.Function (Icon for functions).
| Type | Name | Description |
|---|---|---|
String | oldName | Current name |
String | newName | New name |
Function Modelica.Utilities.Internal.FileSystem.removeFile
This icon indicates Modelica functions.
Extends from Modelica.Icons.Function (Icon for functions).
| Type | Name | Description |
|---|---|---|
String | fileName | File to be removed |
Function Modelica.Utilities.Internal.FileSystem.copyFile
This icon indicates Modelica functions.
Extends from Modelica.Icons.Function (Icon for functions).
| Type | Name | Description |
|---|---|---|
String | fromName | Name of file to be copied |
String | toName | Name of copy of file |
Function Modelica.Utilities.Internal.FileSystem.readDirectory
This icon indicates Modelica functions.
Extends from Modelica.Icons.Function (Icon for functions).
| Type | Name | Description |
|---|---|---|
String | directory | Name of the directory from which information is desired |
Integer | nNames | Number of names that are returned (inquire with getNumberOfFiles) |
| Type | Name | Description |
|---|---|---|
String | names[nNames] | All file and directory names in any order from the desired directory |
Function Modelica.Utilities.Internal.FileSystem.getNumberOfFiles
This icon indicates Modelica functions.
Extends from Modelica.Icons.Function (Icon for functions).
| Type | Name | Description |
|---|---|---|
String | directory | Directory name |
| Type | Name | Description |
|---|---|---|
Integer | result | Number of files and directories present in 'directory' |