Method parDefs

SLiCAP/SLiCAPlatex.py:144–207

Creates a table with parameter definitions 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 parDefs(self, circuitObject, label="", caption="", color="myyellow"):
        """
        Creates a table with parameter definitions 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
        """
        
        headerList = ["ID", "Nodes", "Refs", "Model", "Param", "Symbolic",
                      "Numeric"]
        alignstring= '[c]{lllllll}'
        linesList   = []
        for key in circuitObject.elements.keys():
            el = circuitObject.elements[key]
            line = [key]
            lineItem = ''
            for node in el.nodes:
                lineItem += node + ' '
            line.append(lineItem)
    
            lineItem = ''
            for ref in el.refs:
                lineItem += ref + ' '
            line.append(lineItem)
            line.append(el.model)
            if len(el.params.keys()) == 0:
                line += ['','','']
            else:
                keys = list(el.params.keys())
                for i in range(len(keys)):
                    if i == 0:
                        line.append(keys[i])
                        line.append(el.params[keys[i]])
                        line.append(fullSubs(el.params[keys[i]], 
                                             circuitObject.parDefs))
                        linesList.append(line)
                    else:
                        line = ['','','','']
                        line.append(keys[i])
                        line.append(el.params[keys[i]])