LongTable Class Reference

Inheritance diagram for LongTable:

Collaboration diagram for LongTable:

Public Member Functions
	__init__ (self, columnspecs, caption, format_string, head)
	add (self, *args, **kwargs)
	finish (self, tail='')
	__str__ (self)
	save (self, filename, compile=False)

Public Attributes
	format_string = format_string
	python-style format-string used to generate a new row out of a given dictionary.
str	output = ''
	Stores the outputted latex-code.

Detailed Description

Creates a longtable in latex. A longtable can span multiple pages
and is automatically wrapped.

Definition at line 377 of file b2latex.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			columnspecs,
			caption,
			format_string,
			head )

Calls super-class init, begins centered environment and longtable environment.
Defines caption and head of the table.
    @param columnspecs of the longtable, something like:
            rclp{7cm} 4 columns, right-center-left aligned and one paragraph column with a width of 7cm
    @param caption string or object with implicit string conversion used as caption.
    @param format_string  python-style format-string used to generate a new row out of a given dictionary.
    @param head of the table

Definition at line 383 of file b2latex.py.

    def __init__(self, columnspecs, caption, format_string, head):
        """
        Calls super-class init, begins centered environment and longtable environment.
        Defines caption and head of the table.
            @param columnspecs of the longtable, something like:
                    rclp{7cm} 4 columns, right-center-left aligned and one paragraph column with a width of 7cm
            @param caption string or object with implicit string conversion used as caption.
            @param format_string  python-style format-string used to generate a new row out of a given dictionary.
            @param head of the table
        """
        super().__init__()
        self.output += r"\begin{center}" + '\n'
        self.output += r"\begin{longtable}{" + str(columnspecs) + r"}" + '\n'
        self.output += r"\caption{" + str(caption) + r"}\\" + '\n'
        self.output += r"\toprule" + '\n'
        self.output += head + r"\\" + '\n'
        self.output += r"\midrule" + '\n'
        
        self.format_string = format_string
 

Member Function Documentation

__str__()

__str__ ( self )

inherited

Transform object to string, in this case, just returns .the generated latex-code

Definition at line 26 of file b2latex.py.

    def __str__(self):
        """
        Transform object to string, in this case, just returns .the generated latex-code
        """
        return self.output
 

add()

add	(		self,
		*	args,
		**	kwargs )

Add a new row to the longtable by generating the row using the format_string given in init
and the provided dictionary.
    @param args positional arguments used to generate the row using the python-style format string.
    @param kwargs dictionary used to generate the row using the python-style format-string.

Reimplemented from LatexObject.

Definition at line 403 of file b2latex.py.

    def add(self, *args, **kwargs):
        """
        Add a new row to the longtable by generating the row using the format_string given in init
        and the provided dictionary.
            @param args positional arguments used to generate the row using the python-style format string.
            @param kwargs dictionary used to generate the row using the python-style format-string.
        """
        self.output += self.format_string.format(*args, **kwargs) + r"\\" + '\n'
        return self
 

finish()

finish	(		self,
			tail = '' )

Adds optional tail of the table, ends longtable and centered environment.
    @param tail optional tail, like head but at the bottom of the table.

Reimplemented from LatexObject.

Definition at line 413 of file b2latex.py.

    def finish(self, tail=''):
        """
        Adds optional tail of the table, ends longtable and centered environment.
            @param tail optional tail, like head but at the bottom of the table.
        """
        self.output += r"\bottomrule" + '\n'
        if str(tail) != '':
            self.output += str(tail) + r"\\" + '\n'
            self.output += r"\bottomrule" + '\n'
        self.output += r"\end{longtable}" + '\n'
        self.output += r"\end{center}" + '\n'
        return self
 
 

save()

save ( self, filename, compile = False )

inherited

Saves the latex-code into a file, adds preamble and end of document,
and compiles the code if requested.
    @param filename latex-code is stored in this file, should end on .tex
    @param compile compile the .tex file using pdflatex into a .pdf file

Definition at line 47 of file b2latex.py.

    def save(self, filename, compile=False):
        """
        Saves the latex-code into a file, adds preamble and end of document,
        and compiles the code if requested.
            @param filename latex-code is stored in this file, should end on .tex
            @param compile compile the .tex file using pdflatex into a .pdf file
        """
        output = r"""
            \documentclass[10pt,a4paper]{article}
            \usepackage[latin1]{inputenc}
            \usepackage[T1]{fontenc}
            \usepackage{amsmath}
            \usepackage{amsfonts}
            \usepackage{amssymb}
            \usepackage{graphicx}
            \usepackage{caption}
            \usepackage{lmodern}
            \usepackage{placeins}
            \usepackage{multicol}
            \usepackage{tikz}
            \usetikzlibrary{shapes.arrows,chains, positioning}
            \usepackage{booktabs} %professional tables
            \usepackage[left=2cm,right=2cm,top=2cm,bottom=2cm]{geometry}
            \usepackage{microtype} %optimises spacing, needs to go after fonts
            \usepackage{hyperref} %adds links (also in TOC), should be loaded at the very end
            \usepackage{longtable}
            \usepackage{color}
            \usepackage{listings}
 
            \definecolor{gray}{rgb}{0.4,0.4,0.4}
            \definecolor{darkblue}{rgb}{0.0,0.0,0.6}
            \definecolor{cyan}{rgb}{0.0,0.6,0.6}
 
            \lstset{
              basicstyle=\ttfamily\scriptsize,
              columns=fullflexible,
              showstringspaces=false,
              commentstyle=\color{gray}\upshape
            }
 
            \lstdefinelanguage{XML}
            {
              morestring=[b]",
              morestring=[s]{>}{<},
              morecomment=[s]{<?}{?>},
              stringstyle=\color{black},
              identifierstyle=\color{darkblue},
              keywordstyle=\color{cyan},
              morekeywords={xmlns,version,type}% list your attributes here
            }
 
            \usepackage[load-configurations=abbreviations]{siunitx}
            \makeatletter
            % In newer versions of latex there is a problem with the calc package and tikz
            % http://tex.stackexchange.com/questions/289551/how-to-resolve-conflict-between-versions-of-texlive-and-pgf
            \def\pgfmathparse@#1{%
                % Stuff for calc compatibility.
                \let\real=\pgfmath@calc@real
                \let\minof=\pgfmath@calc@minof
                \let\maxof=\pgfmath@calc@maxof
                \let\ratio=\pgfmath@calc@ratio
                \let\widthof=\pgfmath@calc@widthof
                \let\heightof=\pgfmath@calc@heightof
                \let\depthof=\pgfmath@calc@depthof
                % No (math) units yet.
                \global\pgfmathunitsdeclaredfalse
                \global\pgfmathmathunitsdeclaredfalse
                % Expand expression so any remaining CSs are registers
                % or box dimensions (i.e. |\wd|, |\ht|, |\dp|).
                \edef\pgfmath@expression{#1}%
                    %
                    \expandafter\pgfmathparse@trynumber@loop\pgfmath@expression\pgfmath@parse@stop
                    %
                    % this here is the _real_ parser. it is invoked by
                    % \pgfmathparse@trynumber@loop if that says "this is no number"
                    %\pgfmathparse@@\pgfmath@parse@stop%
                }
            \makeatother
            \begin{document}
            """
        output += self.output
        output += r"\end{document}"
 
        with open(filename, 'w') as f:
            f.write(output)
        if compile:
            for i in range(0, 2):
                ret = subprocess.call(['pdflatex', '-halt-on-error', '-interaction=nonstopmode', filename])
                if ret != 0:
                    raise RuntimeError("pdflatex failed to create FEI summary PDF, please check.")
        return self
 
 

Member Data Documentation

format_string

format_string = format_string

python-style format-string used to generate a new row out of a given dictionary.

Definition at line 401 of file b2latex.py.

output

str output = ''

inherited

Stores the outputted latex-code.

Definition at line 24 of file b2latex.py.

---

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

• framework/scripts/B2Tools/b2latex.py