Method params

SLiCAP/SLiCAPlatex.py:264–303

Creates a table with undefined parameters of *circuitObject*. If no label AND no caption are given this method returns a LaTeX tabular snippet. Else it returns a table snippet. :param circuitObject: SLiCAP circuit object that comprises the circuit

(self, circuitObject, label="", caption="", color="myyellow")

        return Snippet(TEX, self.format)
    
    def params(self, circuitObject, label="", caption="", color="myyellow"):
        """
        Creates a table with undefined parameters of *circuitObject*.
        If no label AND no caption are given this method returns a LaTeX
        tabular snippet. Else it returns a table snippet.

        :param circuitObject: SLiCAP circuit object that comprises the circuit 
                              data to be listed.
        :type circuitObject: SLiCAP.SLiCAPprotos.circuit
        
        :param label: Reference label for the table. Defaults to an empty 
                      string.
        :type label: str
        
        :param caption: Text that will used as table caption.
        :type caption: str
        
        :param color: Alternate row color name, should be defined in 
                     'preambuleSLiCAP.tex' defaults to 'myyellow'. Use None for
                     no background color.
        :type color: str
        
        :return: SLiCAP Snippet object
        :rtype: SLiCAP.SLiCAPprotos.Snippet
        """
        if len(circuitObject.params) > 0:
            TEX         = '{\\textbf{Undefined parameters in: ' 
            TEX        += circuitObject.title + '}}\n\n'
            headerList  = ["Name"]
            alignstring = '[c]{l}'
            linesList   = []
            for parName in circuitObject.params:
                linesList.append([parName])
            TEX += _TEXcreateCSVtable(headerList, linesList, alignstring, 
                                      label=label, caption=caption, 
                                      color=color)
        else:
            TEX = '{\\textbf{No undefined parameters in: ' 
            TEX +=  circuitObject.title + '}}\n\n'
        return Snippet(TEX, self.format)

    def pz(self, resultObject, label="", caption="", color="myyellow"):
        """