MCPcopy Index your code
hub / github.com/SLiCAP/SLiCAP_python / parDefs

Method parDefs

SLiCAP/SLiCAPrst.py:131–163  ·  view source on GitHub ↗

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

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

Source from the content-addressed store, hash-verified

129 return Snippet(RST, self.format)
130
131 def parDefs(self, circuitObject, label="", caption=""):
132 """
133 Creates a table with parameter definitions of *circuitObject*.
134 If no label AND no caption are given this method returns a LaTeX
135 tabular snippet. Else it returns a table snippet.
136
137 :param circuitObject: SLiCAP circuit object that comprises the circuit data to be listed.
138 :type circuitObject: SLiCAP.SLiCAPprotos.circuit
139
140 :param label: Reference label for the table. Defaults to an empty string.
141 :type label: str
142
143 :param caption: Text that will used as table caption.
144 :type caption: str
145
146 :return: SLiCAP Snippet object
147 :rtype: SLiCAP.SLiCAPprotos.Snippet
148 """
149 if len(circuitObject.parDefs) > 0:
150 headerList = ["Name", "Symbolic", "Numeric"]
151 linesList = []
152 for parName in circuitObject.parDefs.keys():
153 line = [parName,
154 circuitObject.parDefs[parName],
155 fullSubs(circuitObject.parDefs[parName],
156 circuitObject.parDefs)]
157 linesList.append(line)
158 RST = _RSTcreateCSVtable(caption, headerList, linesList,
159 numeric=[2], label=label)
160 else:
161 RST = "**No parameter definitions in: "
162 RST += circuitObject.title + '**\n\n'
163 return Snippet(RST, self.format)
164
165 def dictTable(self, dct, head=None, label="", caption=""):
166 """

Callers 3

parameters.pyFile · 0.45
sphinx_report.pyFile · 0.45
subcircuits.pyFile · 0.45

Calls 3

fullSubsFunction · 0.90
SnippetClass · 0.90
_RSTcreateCSVtableFunction · 0.85

Tested by

no test coverage detected