phystricks.src.main.FigureGenerationSuite Class Reference

Inheritance diagram for phystricks.src.main.FigureGenerationSuite:

Collaboration diagram for phystricks.src.main.FigureGenerationSuite:

Public Member Functions
def	__init__ (self, test_list, first=0, title="My beautiful document")
def	generate (self)
def	latex_portion (self, failed_list, lstinputlisting=False)
def	function_list_to_figures_list (self, function_list)
def	summary (self)

Public Attributes
	test_list
	first
	title
	failed_list
	documentation_list
	to_be_recompiled_list

Detailed Description

Generate the figures of a list.

INPUT:

- ``test_list`` - a list of functions that are supposed to produce pspictures

- ``first`` - the position in `test_list` at which we begin the tests

ATTRIBUTES:

- ``failed_list`` - a list of tuple `(function,pspict)` where 
                    `function` is a function that produced a 
                    :class:`PhystricksTestError` and
                    pspict is the produced pspicture.

Constructor & Destructor Documentation

def phystricks.src.main.FigureGenerationSuite.__init__	(		self,
			test_list,
			first = 0,
			title = "My beautiful document"
	)

Member Function Documentation

def phystricks.src.main.FigureGenerationSuite.function_list_to_figures_list	(		self,
			function_list
	)

def phystricks.src.main.FigureGenerationSuite.generate

(

self

)

perform the tests

def phystricks.src.main.FigureGenerationSuite.latex_portion	(		self,
			failed_list,
			lstinputlisting = False
	)

def phystricks.src.main.FigureGenerationSuite.summary

(

self

)

Print the list of failed tests and try to give the 
lines to be included in the LaTeX file in order to
visualize them.

Member Data Documentation

phystricks.src.main.FigureGenerationSuite.documentation_list

phystricks.src.main.FigureGenerationSuite.failed_list

phystricks.src.main.FigureGenerationSuite.first

phystricks.src.main.FigureGenerationSuite.test_list

phystricks.src.main.FigureGenerationSuite.title

phystricks.src.main.FigureGenerationSuite.to_be_recompiled_list

---

The documentation for this class was generated from the following file:

• src/main.py