LatexObject Class Reference

Inheritance diagram for LatexObject:

Public Member Functions
def	__init__ (self)
def	__str__ (self)
def	add (self)
def	finish (self)
def	save (self, filename, compile=False)

Public Attributes
	output
	Stores the outputted latex-code.

Detailed Description

Common base class of all Latex Wrapper objects

Definition at line 14 of file b2latex.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Constructor, initialize output with empty string

Reimplemented in DefineColourList, Graphics, Itemize, LongTable, Listing, Section, SubSection, SubSubSection, String, and TitlePage.

Definition at line 19 of file b2latex.py.

    def __init__(self):
        """
        Constructor, initialize output with empty string
        """
        
        self.output = ''
 

Member Function Documentation

__str__()

def __str__

(

self

)

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

def add

(

self

)

Add latex-code to the output string.
This method is usually overriden in the subclasses

Reimplemented in LongTable, Graphics, Itemize, LatexFile, String, and Listing.

Definition at line 32 of file b2latex.py.

    def add(self):
        """
        Add latex-code to the output string.
        This method is usually overriden in the subclasses
        """
        return self
 

finish()

def finish

(

self

)

Finishes the generation of latex-code.
E.g. adds end latex-commands
This method is usually overriden in the subclasses

Reimplemented in Graphics, Itemize, String, Listing, and LongTable.

Definition at line 39 of file b2latex.py.

    def finish(self):
        """
        Finishes the generation of latex-code.
        E.g. adds end latex-commands
        This method is usually overriden in the subclasses
        """
        return self
 

save()

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

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 compatiability.
                \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 reamining 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

output

output

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