Method specs

SLiCAP/SLiCAPlatex.py:493–529

Creates a table with specifications of type *specType*. If no label AND no caption are given this method returns a LaTeX tabular snippet. Else it returns a table snippet. :param specs: List with SLiCAP.SLiCAPdesignData.specItem objects. :type specs: list

(self, specs, specType, label="", caption="", color="myyellow")

        return Snippet(TEX, self.format)

    def specs(self, specs, specType, label="", caption="", color="myyellow"):
        """
        Creates a table with specifications of type *specType*.
        If no label AND no caption are given this method returns a LaTeX
        tabular snippet. Else it returns a table snippet.

        :param specs: List with SLiCAP.SLiCAPdesignData.specItem objects.
        :type specs: list
        
        :param label: Reference label for the table. Defaults to an empty string.
        :type label: str
        
        :param caption: 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
        """
        linesList   = []
        alignstring = '[c]{llrl}'
        headerList  = ["name", "description", "value", "units"]
        for specItem in specs:
            if specItem.specType.lower() == specType.lower():
                linesList.append(specItem._specLine())
        if len(linesList) > 0:
            TEX = _TEXcreateCSVtable(headerList, linesList, alignstring, 
                                     unitpos=3, caption=caption, label=label, 
                                     color=color) + '\n'
        else:
            TEX =  "\\textbf{Found no specifications of type: " 
            TEX += specType + ".}\n\n"
        return Snippet(TEX, self.format)

    def eqn(self, LHS, RHS, units="", label="", multiline=False):
        """