SLiCAPsummary.txt

STRINGS   :
           CIRCUITPATH
           CSVPATH
           DOCPATH
           HTMLINSERT
           HTMLPATH
           IMGPATH
           LATEXPATH
           LIBCOREPATH
           LIBRARYPATH
           LTSPICE
           MATHMLPATH
           MAXIMA
           NETLIST
           PROJECTPATH
           SPHINXPATH
           SYSINSTALL
           TXTPATH
           USERPATH
           VERSION
           t_ignore

LISTS     :
           CIRCUITNAMES
           CONTROLLED
           CONVTYPES
           DATATYPES
           DEVICETYPES
           GAINTYPES
           INDEPSCRCS
           LABELTYPES
           NODES
           SLiCAPLIBS
           TITLE
           USERLIBS
           VALEXPR

TUPLES    :
           tokens

DICTS     :
           CIRCUITS
           DEVICES
           MODELS
           SCALEFACTORS
           SLiCAPCIRCUITS
           SLiCAPMODELS
           SLiCAPPARAMS
           USERCIRCUITS
           USERMODELS
           USERPARAMS

FUNCTIONS :

CLASSES   :
           Label
           SLiCAPproject
           allResults
           axis
           circuit
           device
           element
           figure
           instruction
           maximaHandler
           model
           modelDef
           settings
           specItem
           trace

======================================================================
                  Classes in detail
======================================================================


Label(self, page, typ, text, name): SLiCAP/SLiCAPhtml

SLiCAPproject(self, name): SLiCAP

allResults(self): SLiCAP/SLiCAPprotos
 - depVars(self.Dv)

axis(self, title): SLiCAP/SLiCAPplots
 - makeTraceDict(self.traces, self.label)

circuit(self): SLiCAP/SLiCAPprotos
 - delPar(self.parUnits, self.parDefs)
 - defPar(self.parUnits, self.parDefs)
 - defPars(self.parDefs)
 - getParValue(self.parDefs)
 - updateParams(self.Symbol, self.frequency, self.Laplace, self.params, self.elements, self.parDefs)
 - getElementValue(self.elements, self.parDefs, self.params)

device(self): SLiCAP/SLiCAPprotos

element(self): SLiCAP/SLiCAPprotos

figure(fileName, self): SLiCAP/SLiCAPplots
 - plot(self.markerSize, self.yScaleFactor, self.title, self.axisHeight, self.yData, self.xScaleFactor, self.show, self.markerColor, self.axes, self.defaultColors, self.fileName, self.plotFontSize, self.figure, self.yLim, self.yLabel, self.traces, self.plot, self.label, self.axisWidth, self.lineWidth, self.markerFaceColor, self.lineType, self.defaultMarkers, self.color, self.xScale, self.add_subplot, self.polar, self.yScale, self.xLim, self.text, self.imgPath, self.shape, self.xLabel, self.marker, self.xData)

instruction(self): SLiCAP/SLiCAPinstruction
 - setSimType(self.simType)
 - checkSimType(self.errors, self.numeric, self.simType)
 - setGainType(self.gainType)
 - checkGainType(self.errors, self.gainType)
 - setConvType(self.convType)
 - checkConvType(self.convType, self.errors)
 - setPairExt(self.pairExt)
 - checkPairExt(self.pairExt)
 - setPairedCircuits(self.pairedCircuits)
 - checkPairedCircuits(self.elements, self.circuit)
 - setDataType(self.dataType)
 - checkDataType(self.dataType, self.errors)
 - stepOn(self.step)
 - stepOff(self.step)
 - setStepVar(self.stepVar)
 - checkStepVar(self.stepVar, self.circuit, self.params, self.Basic, self.parDefs, self.errors)
 - setStepVars(self.stepVars)
 - checkStepVars(self.stepVars, self.circuit, self.params, self.Basic, self.parDefs, self.errors)
 - setStepMethod(self.stepMethod)
 - checkStepMethod(self.stepMethod, self.errors)
 - setStepStart(self.stepStart)
 - checkStepStart(self.stepStart, self.errors)
 - setStepStop(self.stepStop)
 - checkStepStop(self.stepStop, self.errors)
 - setStepNum(self.stepNum)
 - checkStepNum(self.stepNum, self.errors)
 - setStepList(self.stepList)
 - checkStepList(self.stepList, self.errors)
 - setStepArray(self.stepArray)
 - checkStepArray(self.stepVars, self.stepArray, self.errors)
 - setSource(self.source, self.checkSource)
 - checkSource(self.srcUnits, self.source, self.errors)
 - setDetector(self.detector)
 - checkDetector(self.detector, self.lgRef, self.detUnits, self.convType, self.detLabel, self.errors)
 - setLGref(self.lgRef)
 - checkLGref(self.lgRef, self.controlled, self.circuit, self.errors)
 - delPar(self.circuit)
 - defPar(self.circuit)
 - defPars(self.circuit)
 - getParValue(self.numeric, self.circuit, self.simType)
 - getElementValue(self.numeric, self.circuit, self.simType)
 - indepVars(self.indepVars, self.circuit)
 - depVars(self.depVars, self.circuit)
 - controlled(self.controlled, self.circuit)
 - setCircuit(self.circuit)
 - checkCircuit(self.errors, self.params, self.circuit)
 - checkNumeric(self.dataType, self.numeric, self.simType, self.errors)
 - checkStep(self.stepDict, self.stepList, self.stepVar, self.stepVars, self.stepMethod, self.stepArray, self.stepStop, self.step, self.circuit, self.stepNum, self.stepStart, self.parDefs, self.errors)
 - check(self.stepDict, self.gainType, self.convType, self.numeric, self.circuit, self.errors, self.pairExt, self.step, self.dataType, self.checkSource)
 - execute(self.errors)
 - useMatrixConversion(self.conversionMethod)

maximaHandler(self, port, host, maxima, timeout): SLiCAP/SLiCAPpythonMaxima
 - __del__(self.active)
 - runMaxima(self.maxima, self.PORT)
 - startMaxima(self.daemon)
 - restartMaxima(self.active)
 - getResponse(self.conn)
 - parseMaxima(self.conn, self.mut, self.active)
 - maxEval()

model(self): SLiCAP/SLiCAPprotos

modelDef(self): SLiCAP/SLiCAPprotos

settings(self): SLiCAP/SLiCAPini
 - dump()
 - updatePaths(self.circuitPath, self.txtPath, self.sphinxPath, self.defaultLib, self.maxima, self.netlist, self.imgPath, self.userPath, self.csvPath, self.projectPath, self.libraryPath, self.docPath, self.htmlPath, self.latexPath, self.mathmlPath, self.ltspice)

specItem(self, symbol, specType, units, value, description): SLiCAP/SLiCAPdesignData
 - update(self.specType, self.symbol, self.spectype, self.value, self.units)
 - csvLine(self.specType, self.symbol, self.description, self.value, self.units)
 - htmlLine(self.units, self.symbol, self.value, self.description)
 - specLine(self.units, self.symbol, self.value, self.description)

trace(traceData, self): SLiCAP/SLiCAPplots
 - makeTable(self.xData, self.xName, self.yData, self.yName)