Executive

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

FigureMaker methods

def_enter_context_function(cmd)  [ doc ]

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

def_enter_page_function(cmd)  [ doc ]

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()` and
`default_enter_page_function()`.

def_enter_show_plot_function(cmd)  [ doc ]

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

def_enter_subfigure_function(cmd)  [ doc ]

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

def_enter_subplot_function(cmd)  [ doc ]

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

def_eval_function(cmd)  [ doc ]

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

def_exit_context_function(cmd)  [ doc ]

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

def_exit_page_function(cmd)  [ doc ]

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()`.

def_exit_show_plot_function(cmd)  [ doc ]

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

def_exit_subfigure_function(cmd)  [ doc ]

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

def_exit_subplot_function(cmd)  [ doc ]

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

def_figure(name, cmd)  [ doc ]

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

default_enter_page_function()  [ doc ]

Calls `page_setup()` with the current
`self.default_page_width` and `self.default_page_height`.
Then calls `set_frame_sides()` with `self.default_frame_left`,
`self.default_frame_right`, `self.default_frame_top`, and
`self.default_frame_bottom`.

eval_function(string)  [ doc ]

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 Python's
`eval(string)`.

figure_index(name)  [ doc ]

Returns the index of the figure with the given `name`.

figure_name(num)  [ doc ]

Returns the num-th name defined in the `self.figure_names` array.

figure_pdf(name)  [ doc ]

Returns the corresponding entry from the `self.figure_pdfs` array.

get_save_filename(name)  [ doc ]

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

make_all(fignums=None, report=False)  [ doc ]

Calls `make_pdf()` for each of the figures listed in
`fignums`.  Does all the defined figures if `fignums` is None.
See also `require_all()`.  Writes PDF information to terminal
as it goes if `report` is True.

make_pdf(name)  [ doc ]

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

make_portfolio(name, fignums=None, report=False)  [ doc ]

Creates a multipage PDF file containing the figures listed in
`fignums`.  Does all the defined figures if `fignums` is None.
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
`self.save_dir`.

require_all(fignums=None, report=False, always_make=False)  [ doc ]

Calls `require_pdf()` for each of the figures listed in
`fignums`.  Does all the defined figures if `fignums` is None.
Writes PDF information to terminal as it goes if `report` is
True.

require_pdf(num)  [ doc ]

Calls `make_pdf()` if the PDF file for the figure has not yet
been created.  Returns the full file name of the PDF.

reset_enter_context_function()  [ doc ]

Removes the current definition for the
`enter_context_function()`.  See also
`def_enter_context_function()`.

reset_enter_page_function()  [ doc ]

Removes the current definition for the
`self.enter_page_function`.  See also
`def_enter_page_function()` and
`default_enter_page_function()`.

reset_enter_show_plot_function()  [ doc ]

Removes the current definition for the
`enter_show_plot_function()`.  See also
`def_enter_show_plot_function()`.

reset_enter_subfigure_function()  [ doc ]

Removes the current definition for the
`enter_subfigure_function()`.  See also
`def_enter_subfigure_function().

reset_enter_subplot_function()  [ doc ]

Removes the current definition for the
`enter_subplot_function()`.  See also
`def_enter_subplot_function()`.

reset_eval_function()  [ doc ]

Removes the current definition for the `self.eval_function`.
See also `def_eval_function()`.

reset_exit_context_function()  [ doc ]

Removes the current definition for the
`exit_context_function()`.  See also
`def_exit_context_function()`.

reset_exit_page_function()  [ doc ]

Removes the current definition for the `exit_page_function()`.
See also `def_exit_page_function()`.

reset_exit_show_plot_function()  [ doc ]

Removes the current definition for the
`exit_show_plot_function()`.  See also
`def_exit_show_plot_function()`.

reset_exit_subfigure_function()  [ doc ]

Removes the current definition for the
`exit_subfigure_function()`.  See also
`def_exit_subfigure_function()`.

reset_exit_subplot_function()  [ doc ]

Removes the current definition for the
`exit_subplot_function()`.  See also
`def_exit_subplot_function()`.

reset_figures()  [ doc ]

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

FigureMaker attributes

autocleanup  [ doc ]

Whether or not to do automatic cleanup of the temporary files
after creating a PDF for a figure (default is True).

create_save_dir  [ doc ]

Whether or not to create `self.save_dir` if it does not exist.

default_frame_bottom  [ doc ]

The frame bottom for use by `default_enter_page_function()`.

default_frame_left  [ doc ]

The frame left for use by `default_enter_page_function()`.

default_frame_right  [ doc ]

The frame right for use by `default_enter_page_function()`.

default_frame_top  [ doc ]

The frame top for use by `default_enter_page_function()`.

default_page_height  [ doc ]

The page height for use by `default_enter_page_function()`.

default_page_width  [ doc ]

The page width for use by `default_enter_page_function()`.

figure_names  [ doc ]

An array of names for the currently defined figures.

figure_pdfs  [ doc ]

An array of full PDF filenames for the currently defined
figures.  All entries in the array initialized to None.  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 `self.figure_names`.

use_multithreads  [ doc ]

Whether or not to use multithreading wherever possible
(default is True).  Currently, this only is used when making a
batch of PDFs -- if `self.use_multithreads` is True, then we
launch all the pdflatex shells in parallel.

num_figures  [ doc ]

The current number of defined figures for this FigureMaker.

pdflatex  [ doc ]

The name for the pdflatex to use.  Defaults to 'pdflatex'.

quiet_mode  [ doc ]

Defaults to False.  If True, turns off all but essential
messages.

run_dir  [ doc ]

The path name for the FigureMaker working directory.

save_dir  [ doc ]

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

PyTioga version: alpha (20071021)

Copyright (C) 2007 Taro Sato & Bill Paxton. All rights reserved.