Class Tioga::Executive
In: split/Tioga/lib/Executive.rb
Parent: Doc< FigureMaker

These are the methods and attributes for controlling the FigureMaker executive routines.

Methods

Public Instance methods

Whether or not to do automatic cleanup of the temporary files when create a PDF for a figure (default is true).

Whether or not to create save_dir if it doesn‘t exist.

The block of code is saved to be executed later whenever context is called. See also reset_enter_context_function.

The block of code is saved to be executed later whenever make_pdf is called to create a page for a figure. See also reset_enter_page_function, default_enter_page_function.

The block of code is saved to be executed later whenever show_plot is called. See also reset_enter_show_plot_function.

The block of code is saved to be executed later whenever subfigure is called. See also reset_enter_subfigure_function.

The block of code is saved to be executed later whenever subplot is called. See also reset_enter_subplot_function.

The block of code is saved to be executed later when eval_function is called. See also reset_eval_function.

The block of code is saved to be executed whenever context returns. See also reset_exit_context_function.

The block of code is saved to be executed later after make_pdf has returned from creating a page for a figure. See also reset_exit_page_function.

The block of code is saved to be executed whenever show_plot returns. See also reset_exit_show_plot_function.

The block of code is saved to be executed whenever subfigure returns. See also reset_exit_subfigure_function.

The block of code is saved to be executed whenever subplot returns. See also reset_exit_subplot_function.

The block of code is saved to be executed later when the name string is given to make_figure. The name is entered in the table of figure_names. If the name was already listed, then the new code replaces the previous definition.

Calls the function block defined by a previous call to def_eval_function passing the string as argument. If no function is currently defined, it calls Ruby‘s eval with string.

Returns the index of the figure with the given name.

Returns the name from the figure_names array.

An array of names for the currently defined figures.

An array of full pdf filenames for the currently defined figures. All entries in the array initialized to nil. When a pdf is created for a figure, the full filename for the pdf is placed in this array in position corresponding to the figure‘s location in figure_names.

Returns a string with the filename that will be used for saving the figure with the given name.

Calls make_pdf for each of the figures listed in fignums. Does all the defined figures if fignums is nil. See also require_all. Writes pdf information to terminal as it goes if report is true.

Executes the corresponding code that was previously saved by def_figure. Output is written to the currently specified save_dir directory. Alias for make_pdf.

Executes the corresponding code that was previously saved by def_figure. Output is written to the currently specified save_dir directory. See also require_pdf.

Creates a multipage pdf file containing the figures listed in fignums. Does all the defined figures if fignums is nil. Writes pdf information to terminal as it goes if report is true.

First, make_portfolio calls require_all(fignums) so that all the pdfs will be available. The portfolio will have the given name with a ".pdf" extension and will be placed in the save_dir.

Whether or not to use multithreading wherever possible (default is true). Currently, this only is used when making a batch of pdfs — if multithreads_okay_for_tioga is true, then we launch all the pdflatex shells in parallel.

The current number of defined figures for this FigureMaker.

The name for the pdflatex to use. Defaults to ‘pdflatex’.

Defaults to false. If true, turns off all but essential messages.

Calls require_pdf for each of the figures listed in fignums. Does all the defined figures if fignums is nil. Writes pdf information to terminal as it goes if report is true.

Calls make_pdf if the pdf for the figure has not yet been created. Returns the full file name of the pdf.

Removes the current definition for the enter_context_function. See also def_enter_context_function.

Removes the current definition for the enter_page_function. See also def_enter_page_function, default_enter_page_function.

Removes the current definition for the enter_show_plot_function. See also def_enter_show_plot_function.

Removes the current definition for the enter_subfigure_function. See also def_enter_subfigure_function.

Removes the current definition for the enter_subplot_function. See also def_enter_subplot_function.

Removes the current definition for the eval_function. See also def_eval_function.

Removes the current definition for the exit_context_function. See also def_exit_context_function.

Removes the current definition for the exit_page_function. See also def_exit_page_function.

Removes the current definition for the exit_show_plot_function. See also def_exit_show_plot_function.

Removes the current definition for the exit_subfigure_function. See also def_exit_subfigure_function.

Removes the current definition for the exit_subplot_function. See also def_exit_subplot_function.

Reinitializes the FigureMaker. This is automatically called when you load or reload a tioga document file.

The path name for the FigureMaker working directory.

The path name for the directory where output files will be created.

[Validate]