gnuplot_open_fileT_gnuplot_open_fileGnuplotOpenFileGnuplotOpenFile (Operator)

Name

gnuplot_open_fileT_gnuplot_open_fileGnuplotOpenFileGnuplotOpenFile — Open a gnuplot file for visualization of images and control values.

Warning

gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFile is obsolete and is only provided for reasons of backward compatibility.

Signature

gnuplot_open_file( : : FileName : GnuplotFileID)

gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFile allows the output of images and control values in a format which can be later processed by gnuplot. The parameter FileNameFileNameFileNameFileNamefileName determines the base-name of the files to be created by calls to gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImage. gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFile generates a gnuplot control file with the name <Filename>.gp, in which the respective plot commands are written. Each image plotted by gnuplot_plot_imagegnuplot_plot_imageGnuplotPlotImageGnuplotPlotImageGnuplotPlotImage (or control values plotted by gnuplot_plot_ctrlgnuplot_plot_ctrlGnuplotPlotCtrlGnuplotPlotCtrlGnuplotPlotCtrl) creates a data file with the name Filename.dat.<Number>, where Number is the number of the plot in the current sequence. The generated control file can later be edited to create the desired effect. After the last plot gnuplot_closegnuplot_closeGnuplotCloseGnuplotCloseGnuplotClose has to be called in order to close all open files. The corresponding identifier for the gnuplot output stream is returned in GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileID.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

FileNameFileNameFileNameFileNamefileName (input_control) filename.write → (string)

Base name for control and data files.

File extension: .gp

GnuplotFileIDGnuplotFileIDGnuplotFileIDGnuplotFileIDgnuplotFileID (output_control) gnuplot_id → (handle)

Identifier for the gnuplot output stream.

Result

gnuplot_open_filegnuplot_open_fileGnuplotOpenFileGnuplotOpenFileGnuplotOpenFile returns the value 2 (H_MSG_TRUE) if the control file could be opened. Otherwise, an exception is raised.