file

file

factory file

Description:

  • Specifies the file system specific functions.

    • These functions are accessible via the aidesys:: prefix.

Methods

(static) readDir(path, patternopt) → {Array.<string>}

Description:

  • Lists all files of a directory.

Parameters:
Name Type Attributes Default Description
path string

The directory to list.
pattern string <optional>
 ".*"

The file pattern regular expression using the ECMAScript syntax.
Returns:

A std::vector<std::string> structure with the file names.

  • The file base names with file extension and without the directory path are provided.
Type
Array.<string>

(static) getFileTime(filename)

Description:

  • Gets the file last modificaton time, in milliseconds.

Parameters:
Name Type Description
filename string

The file path name.
Returns:

The file last modificaton time, in milliseconds, since January 1, 1970, midnight, UTC/GMT (i.e., Greewitch time).

  • Returns NAN, if the file does not exists:
    • So: std::isnan(aidesys::getFileTime(file)) is equivalent to aidesys::exists(file).

(static) path(filename, whatopt)

Description:

  • Returns a filename path element.

Parameters:
Name Type Attributes Default Description
filename string

The file path name.
what char <optional>
 'b'
  • 'b' The base-name of the file without extension.
  • 'f' The file base-name with the extension.
  • 'e' The extension of the filename.
  • 'd' The directory name of the filename.
  • 'n' The normalized path name, resolving the . and .. path elements, and multiple /.
  • 'r' The real absolute normalized path name, taking system existing location into account.
Returns:

The filename element.

(static) exists(filename) → {bool}

Description:

  • Checks if a file exists.

Parameters:
Name Type Description
filename string

The file path name.
Returns:

True if the file exists and is readable, false otherwise.

Type
bool

(static) load(filename) → {string}

Description:

  • Loads a textual file.

Parameters:
Name Type Description
filename string

The file path name.
Returns:

The file contents as a string.

Type
string

(static) save(filename, string)

Description:

  • Saves a textual file.

    • The file directory is created, if required.
    • If the file already exists, a backup of name filename~ is created.
Parameters:
Name Type Description
filename string

The file path name.
string string

The file contents as a string.

(static) gnuplot(file, plot, dataopt)

Description:

  • Generated a gnuplot interface display script.

Parameters:
Name Type Attributes Default Description
file string

The related data file name (without extension). By contract,

  • the file basename is used as the plot title;
  • the display script is generated in $file.gnuplot.sh.
  • the plot image is generated in $file.png.
  • the data is stored in a $file.dat.

To display the gnuplot, run $file.gnuplot.sh.
plot string

The gnuplot display commands.
data string <optional>
 ""

An optional string with the plot data.