class Tioga::Executive
These are the methods and attributes for controlling the FigureMaker
executive routines.
Public Instance Methods
Whether or not to do automatic cleanup of the temporary files when create a PDF for a figure (default is true).
# File lib/Tioga/Executive.rb, line 438 def autocleanup end
Whether or not to create save_dir
if it doesn’t exist.
# File lib/Tioga/Executive.rb, line 430 def create_save_dir end
The block of code is saved to be executed later whenever context is called.
See also reset_enter_context_function.
# File lib/Tioga/Executive.rb, line 379 def def_enter_context_function(&cmd) end
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.
# File lib/Tioga/Executive.rb, line 151 def def_enter_page_function(&cmd) end
The block of code is saved to be executed later whenever show_plot is called.
See also reset_enter_show_plot_function.
# File lib/Tioga/Executive.rb, line 252 def def_enter_show_plot_function(&cmd) end
The block of code is saved to be executed later whenever subfigure is called.
See also reset_enter_subfigure_function.
# File lib/Tioga/Executive.rb, line 293 def def_enter_subfigure_function(&cmd) end
The block of code is saved to be executed later whenever subplot is called.
See also reset_enter_subplot_function.
# File lib/Tioga/Executive.rb, line 334 def def_enter_subplot_function(&cmd) end
The block of code is saved to be executed later when eval_function
is called. See also reset_eval_function.
# File lib/Tioga/Executive.rb, line 134 def def_eval_function(&cmd) end
The block of code is saved to be executed whenever context returns.
See also reset_exit_context_function.
# File lib/Tioga/Executive.rb, line 398 def def_exit_context_function(&cmd) end
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.
# File lib/Tioga/Executive.rb, line 233 def def_exit_page_function(&cmd) end
The block of code is saved to be executed whenever show_plot returns.
See also reset_exit_show_plot_function.
# File lib/Tioga/Executive.rb, line 271 def def_exit_show_plot_function(&cmd) end
The block of code is saved to be executed whenever subfigure returns.
See also reset_exit_subfigure_function.
# File lib/Tioga/Executive.rb, line 312 def def_exit_subfigure_function(&cmd) end
The block of code is saved to be executed whenever subplot returns.
See also reset_exit_subplot_function.
# File lib/Tioga/Executive.rb, line 353 def def_exit_subplot_function(&cmd) end
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.
# File lib/Tioga/Executive.rb, line 16 def def_figure(name, &cmd) end
Calls page_setup with the current default_page_width
and default_page_height. Then calls set_frame_sides with default_frame_left
, default_frame_right
, default_frame_top
, and default_frame_bottom.
# File lib/Tioga/Executive.rb, line 168 def default_enter_page_function end
The frame bottom for use by default_enter_page_function.
# File lib/Tioga/Executive.rb, line 222 def default_frame_bottom end
The frame left for use by default_enter_page_function.
# File lib/Tioga/Executive.rb, line 195 def default_frame_left end
The frame right for use by default_enter_page_function.
# File lib/Tioga/Executive.rb, line 204 def default_frame_right end
The frame top for use by default_enter_page_function.
# File lib/Tioga/Executive.rb, line 213 def default_frame_top end
The page height for use by default_enter_page_function.
# File lib/Tioga/Executive.rb, line 186 def default_page_height end
The page width for use by default_enter_page_function.
# File lib/Tioga/Executive.rb, line 177 def default_page_width end
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.
# File lib/Tioga/Executive.rb, line 140 def eval_function(string) end
Returns the index of the figure with the given name.
# File lib/Tioga/Executive.rb, line 102 def figure_index(name) end
Returns the name from the figure_names
array.
# File lib/Tioga/Executive.rb, line 492 def figure_name(num) end
An array of names for the currently defined figures.
# File lib/Tioga/Executive.rb, line 485 def figure_names end
Returns the corresponding entry from the figure_pdfs
array.
# File lib/Tioga/Executive.rb, line 510 def figure_pdf(num) end
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.
# File lib/Tioga/Executive.rb, line 502 def figure_pdfs end
Returns a string with the filename that will be used for saving the figure with the given name.
# File lib/Tioga/Executive.rb, line 471 def get_save_filename(name) end
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.
# File lib/Tioga/Executive.rb, line 46 def make_all(fignums=nil,report=false) end
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.
# File lib/Tioga/Executive.rb, line 57 def make_figure(name) end
First, if there is a command block given, def_figure
is called to save it. Then make_pdf
executes the command corresponding to the given name or number. Output is written to the currently specified save_dir
directory. See also require_pdf.
# File lib/Tioga/Executive.rb, line 70 def make_pdf(n,&cmd) end
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.
# File lib/Tioga/Executive.rb, line 84 def make_portfolio(name,fignums=nil,report=false) end
Alias for make_portfolio.
# File lib/Tioga/Executive.rb, line 92 def make_portfolio_pdf(name,fignums=nil,report=false) end
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.
# File lib/Tioga/Executive.rb, line 447 def multithreads_okay_for_tioga end
The current number of defined figures for this FigureMaker
.
# File lib/Tioga/Executive.rb, line 478 def num_figures end
The name for the pdflatex to use. Defaults to ‘pdflatex’.
# File lib/Tioga/Executive.rb, line 455 def pdflatex end
Defaults to false
. If true
, turns off all but essential messages.
# File lib/Tioga/Executive.rb, line 464 def quiet_mode end
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.
# File lib/Tioga/Executive.rb, line 36 def require_all(fignums=nil,report=false) end
Calls make_pdf
if the pdf for the figure has not yet been created. Returns the full file name of the pdf.
# File lib/Tioga/Executive.rb, line 26 def require_pdf(name) end
Removes the current definition for the enter_context_function. See also def_enter_context_function.
# File lib/Tioga/Executive.rb, line 387 def reset_enter_context_function end
Removes the current definition for the enter_page_function. See also def_enter_page_function
, default_enter_page_function.
# File lib/Tioga/Executive.rb, line 159 def reset_enter_page_function end
Removes the current definition for the enter_show_plot_function. See also def_enter_show_plot_function.
# File lib/Tioga/Executive.rb, line 260 def reset_enter_show_plot_function end
Removes the current definition for the enter_subfigure_function. See also def_enter_subfigure_function.
# File lib/Tioga/Executive.rb, line 301 def reset_enter_subfigure_function end
Removes the current definition for the enter_subplot_function. See also def_enter_subplot_function.
# File lib/Tioga/Executive.rb, line 342 def reset_enter_subplot_function end
Removes the current definition for the eval_function. See also def_eval_function.
# File lib/Tioga/Executive.rb, line 126 def reset_eval_function end
Removes the current definition for the exit_context_function. See also def_exit_context_function.
# File lib/Tioga/Executive.rb, line 406 def reset_exit_context_function end
Removes the current definition for the exit_page_function. See also def_exit_page_function.
# File lib/Tioga/Executive.rb, line 241 def reset_exit_page_function end
Removes the current definition for the exit_show_plot_function. See also def_exit_show_plot_function.
# File lib/Tioga/Executive.rb, line 279 def reset_exit_show_plot_function end
Removes the current definition for the exit_subfigure_function. See also def_exit_subfigure_function.
# File lib/Tioga/Executive.rb, line 320 def reset_exit_subfigure_function end
Removes the current definition for the exit_subplot_function. See also def_exit_subplot_function.
# File lib/Tioga/Executive.rb, line 361 def reset_exit_subplot_function end
Alias for reset_state.
# File lib/Tioga/Executive.rb, line 116 def reset_figures end
Reinitializes the FigureMaker
. This is automatically called when you load or reload a tioga document file.
# File lib/Tioga/Executive.rb, line 109 def reset_state end
The path name for the FigureMaker
working directory.
# File lib/Tioga/Executive.rb, line 414 def run_dir end
The path name for the directory where output files will be created.
# File lib/Tioga/Executive.rb, line 422 def save_dir end