::SpiceGenTcl¶
Commands¶
forgetCommon¶
Forgets all ::SpiceGenTcl::Common commands from caller namespace
forgetCommon
forgetLtspice¶
Forgets all ::SpiceGenTcl::Ltspice commands from caller namespace
forgetLtspice
forgetNgspice¶
Forgets all ::SpiceGenTcl::Ngspice commands from caller namespace
forgetNgspice
forgetXyce¶
Forgets all ::SpiceGenTcl::Xyce commands from caller namespace
forgetXyce
importCommon¶
Imports all ::SpiceGenTcl::Common commands to caller namespace
importCommon
importLtspice¶
Imports all ::SpiceGenTcl::Ltspice commands to caller namespace
importLtspice
importNgspice¶
Imports all ::SpiceGenTcl::Ngspice commands to caller namespace
importNgspice
importXyce¶
Imports all ::SpiceGenTcl::Xyce commands to caller namespace
importXyce
Classes¶
Analysis¶
Method summary
- constructor
Constructor for the class.
- destructor
Destructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- actOnParam
Acts on
Parameterobject with selected action.- genSPICEString
Creates analysis for SPICE netlist.
Properties
-name:Readable, writable.
-type:Readable, writable.
Superclasses
Mixins
Subclasses
::SpiceGenTcl::Common::Analyses::Dc, ::SpiceGenTcl::Common::Analyses::Ac, ::SpiceGenTcl::Common::Analyses::Tran, ::SpiceGenTcl::Common::Analyses::Op, ::SpiceGenTcl::Ngspice::Analyses::Sp, ::SpiceGenTcl::Ngspice::Analyses::SensAc, ::SpiceGenTcl::Ngspice::Analyses::SensDc, ::SpiceGenTcl::Xyce::Analyses::Sens
constructor¶
Creates object of class Analysis.
OBJECT constructor type params ?-name value?
Parameters
-name value:Name of the string that could be used to retrieve element from ::SpiceGenTcl::Netlist object and its descendants, optional.
params:List of instance parameters in form
{{name value} {name -sw} {name Value -eq} {name Value -posnocheck} ...}type:Type of analysis, for example,
tran,ac,dc, etc.
Description
Class models analysis statement.
destructor¶
Destroy object of class Analysis, and its ``Parameter``s objects.
ANALYSISOBJ destroy
actOnParam¶
Acts on Parameter object with selected action
OBJECT actOnParam -add ?-pos|eq|poseq|posnocheck|nocheck|sw|node|nodeeq? name value OBJECT actOnParam -set name value ?name value ...? OBJECT actOnParam -get name OBJECT actOnParam -get -all OBJECT actOnParam -delete name
Parameters
-add:Add new parameter to the device, requires
pnameargument.-all:Option for getting the dictionary that contains parameters names as keys and parameters values # as the dictionary values, requires
-get-delete:Delete existing parameter.
-eq:Parameter may contain equation in terms of functions and other parameters, printed as
$name={$equation}, requires-add-get:Get parameter value, requires
pnameargument.-nocheck:Normal parameter without check, requires
-add-node:Node parameter, requires
-add-nodeeq:Node parameter equation, requires
-add-pos:Parameter has strict position and only
$valueis displayed in netlist, requires-add-poseq:Combination of both flags, print only, requires
-add-posnocheck:Positional parameter without check, requires
-add-set:Set (or change) value of particular parameters, requires
pnameandvaluearguments.-sw:Switch parameter, requires
-addarguments:Optional pairs of name-value for
-setaction, requires-setpname:Name of parameter.
value:Value of parameter.
genSPICEString¶
Creates analysis for SPICE netlist.
ANALYSISOBJ genSPICEString
Return value
string SPICE netlist’s string
Axis¶
Method summary
- configure
Configure properties. See ::oo::configuresupport::configurable.
- appendDataPoints
Inherited from Dataset.
- getDataPoints
Inherited from Dataset.
- getStr
Inherited from Dataset.
- setDataPoints
Inherited from Dataset.
Properties
-len:Readable, writable. Inherited.
-name:Readable, writable. Inherited.
-numtype:Readable, writable. Inherited.
-type:Readable, writable. Inherited.
Superclasses
BinaryReader¶
Method summary
- configure
Configure properties. See ::oo::configuresupport::configurable.
- readComplex
Reads two 8 byte numbers from file.
- readFloat32
Reads 4 bytes number from file.
- readFloat64
Reads 8 bytes number from file .
- skip4bytes
Moves pointer of position in file forward in 4 bytes.
- skip8bytes
Moves pointer of position in file forward in 8 bytes.
- skip16bytes
Moves pointer of position in file forward in 16 bytes.
Subclasses
readComplex¶
Reads two 8 byte numbers from file.
BINARYREADEROBJ readComplex file
Parameters
file:File handler.
Return value
list of two values.
readFloat32¶
Reads 4 bytes number from file.
BINARYREADEROBJ readFloat32 file
Parameters
file:File handler.
Return value
value of number.
readFloat64¶
Reads 8 bytes number from file .
BINARYREADEROBJ readFloat64 file
Parameters
file:File handler.
Return value
value of number.
skip4bytes¶
Moves pointer of position in file forward in 4 bytes.
BINARYREADEROBJ skip4bytes file
Parameters
file:File handler.
skip8bytes¶
Moves pointer of position in file forward in 8 bytes.
BINARYREADEROBJ skip8bytes file
Parameters
file:File handler.
skip16bytes¶
Moves pointer of position in file forward in 16 bytes.
BINARYREADEROBJ skip16bytes file
Parameters
file:File handler.
Circuit¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- add
Adds elements object to Circuit
Elementsdictionary.- del
Deletes elements from the circuit by its name.
- detachSimulator
Removes
Simulatorobject reference fromCircuit.- genSPICEString
Creates circuit string for SPICE netlist.
- getDataCsv
Returns string with CSV formatting containing all data.
- getDataDict
Gets dictionary with raw data vectors.
- getAllElemNames
Inherited from Netlist.
- getElement
Inherited from Netlist.
- runAndRead
Invokes
runAndRead,configure -logandconfigure -datamethods from attached simulator.
Properties
-data:Readable, writable.
-log:Readable, writable.
-name:Readable, writable. Inherited.
-simulator:Readable, writable.
Superclasses
constructor¶
Creates object of class CircuitNetlist.
OBJECT constructor name
Parameters
name:Name of the tol-level circuit.
Description
Class implements a top level netlist which is run in SPICE. We should add ::SpiceGenTcl::Simulator object reference to make it able to run simulation.
add¶
Adds elements object to Circuit Elements dictionary.
OBJECT add element ?element ...?
Parameters
elements:Elements objects references.
del¶
Deletes elements from the circuit by its name.
OBJECT del elementName ?elementName ...?
Parameters
args:Elements names.
detachSimulator¶
Removes Simulator object reference from Circuit.
CIRCUITOBJ detachSimulator ?args?
Parameters
genSPICEString¶
Creates circuit string for SPICE netlist.
CIRCUITOBJ genSPICEString
Return value
SPICE netlist’s string
getDataCsv¶
Returns string with CSV formatting containing all data
OBJECT getDataCsv ?-all? ?-traces list? ?-sep value?
Parameters
-all:Select all traces.
-sep value:Separator of columns, default is comma.
-traces list:Select names of traces to return.
Return value
Returns string with CSV formatting containing all data
getDataDict¶
Gets dictionary with raw data vectors.
CIRCUITOBJ getDataDict ?args?
Parameters
Return value
dict with vectors data, keys - names of vectors
runAndRead¶
Invokes runAndRead, configure -log and configure -data methods from attached simulator.
OBJECT runAndRead ?-nodelete?
Parameters
-nodelete:Flag to forbid simulation file deletion.
Comment¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates comment string for SPICE netlist.
Properties
-name:Readable, writable. Inherited.
-value:Readable, writable. Inherited.
Superclasses
constructor¶
Creates object of class Comment.
OBJECT constructor value ?-name value?
Parameters
-name value:Name of the string that could be used to retrieve element from ::SpiceGenTcl::Netlist object and its descendants, optional.
value:Value of the comment.
Description
Class represent comment string, it can be a multiline comment.
genSPICEString¶
Creates comment string for SPICE netlist.
COMMENTOBJ genSPICEString
Return value
SPICE netlist’s string
Dataset¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- appendDataPoints
Appends the data points to the existing ones.
- getDataPoints
Gets the data points.
- getStr
Returns metadata of
Dataset- setDataPoints
Sets the data points.
Properties
-len:Readable, writable.
-name:Readable, writable.
-numtype:Readable, writable.
-type:Readable, writable.
Subclasses
constructor¶
Initializes Dataset object.
Dataset create OBJNAME ?args? Dataset new ?args?
Parameters
len:Total number of points.
name:Name of the dataset.
numtype:Numerical type of dataset.
type:Type of dataset.
appendDataPoints¶
Appends the data points to the existing ones
DATASETOBJ appendDataPoints dataPoint
Parameters
dataPoint:Not documented.
dataPoints:Data points.
getDataPoints¶
Gets the data points
DATASETOBJ getDataPoints ?args?
Parameters
getStr¶
Returns metadata of Dataset
DATASETOBJ getStr
Return value
Returns metadata of Dataset
setDataPoints¶
Sets the data points
DATASETOBJ setDataPoints dataPoints
Parameters
dataPoints:Data points.
Device¶
Method summary
- constructor
Constructor for the class.
- destructor
Destructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- actOnParam
Acts on
Parameterobject with selected action.- actOnPin
Acts on
Pinobject with selected action.- checkFloatingPins
Check if some pin device doesn’t have connected nodes and return list of them.
- genSPICEString
Creates device string for SPICE netlist.
Properties
-name:Readable, writable.
Superclasses
Mixins
Subclasses
::SpiceGenTcl::Common::BasicDevices::Resistor, ::SpiceGenTcl::Common::BasicDevices::Capacitor, ::SpiceGenTcl::Common::BasicDevices::Inductor, ::SpiceGenTcl::Common::BasicDevices::SubcircuitInstance, ::SpiceGenTcl::Common::BasicDevices::VSwitch, ::SpiceGenTcl::Common::BasicDevices::CSwitch, ::SpiceGenTcl::Common::BasicDevices::SubcircuitInstanceAuto, ::SpiceGenTcl::Common::Sources::dc, ::SpiceGenTcl::Common::Sources::ac, ::SpiceGenTcl::Common::Sources::pulse, ::SpiceGenTcl::Common::Sources::sin, ::SpiceGenTcl::Common::Sources::exp, ::SpiceGenTcl::Common::Sources::pwl, ::SpiceGenTcl::Common::Sources::sffm, ::SpiceGenTcl::Common::Sources::Vccs, ::SpiceGenTcl::Common::Sources::Vcvs, ::SpiceGenTcl::Common::Sources::Cccs, ::SpiceGenTcl::Common::Sources::Ccvs, ::SpiceGenTcl::Ngspice::BasicDevices::Resistor, ::SpiceGenTcl::Ngspice::BasicDevices::Capacitor, ::SpiceGenTcl::Ngspice::BasicDevices::Inductor, ::SpiceGenTcl::Ngspice::BasicDevices::Coupling, ::SpiceGenTcl::Ngspice::BasicDevices::SubcircuitInstance, ::SpiceGenTcl::Ngspice::BasicDevices::SubcircuitInstanceAuto, ::SpiceGenTcl::Ngspice::BasicDevices::VerilogA, ::SpiceGenTcl::Ngspice::Sources::pulse, ::SpiceGenTcl::Ngspice::Sources::sffm, ::SpiceGenTcl::Ngspice::Sources::am, ::SpiceGenTcl::Ngspice::Sources::Vport, ::SpiceGenTcl::Ngspice::Sources::BehaviouralSource, ::SpiceGenTcl::Ngspice::SemiconductorDevices::Diode, ::SpiceGenTcl::Ngspice::SemiconductorDevices::Bjt, ::SpiceGenTcl::Ngspice::SemiconductorDevices::Jfet, ::SpiceGenTcl::Ngspice::SemiconductorDevices::Mesfet, ::SpiceGenTcl::Ngspice::SemiconductorDevices::Mosfet, ::SpiceGenTcl::Xyce::BasicDevices::Resistor, ::SpiceGenTcl::Xyce::BasicDevices::Capacitor, ::SpiceGenTcl::Xyce::BasicDevices::Inductor, ::SpiceGenTcl::Xyce::BasicDevices::GenSwitch, ::SpiceGenTcl::Xyce::BasicDevices::SubcircuitInstance, ::SpiceGenTcl::Xyce::BasicDevices::SubcircuitInstanceAuto, ::SpiceGenTcl::Xyce::Sources::BehaviouralSource, ::SpiceGenTcl::Xyce::SemiconductorDevices::Diode, ::SpiceGenTcl::Xyce::SemiconductorDevices::Bjt, ::SpiceGenTcl::Xyce::SemiconductorDevices::Jfet, ::SpiceGenTcl::Xyce::SemiconductorDevices::Mesfet, ::SpiceGenTcl::Xyce::SemiconductorDevices::Mosfet, ::SpiceGenTcl::Ltspice::BasicDevices::Capacitor, ::SpiceGenTcl::Ltspice::BasicDevices::Inductor, ::SpiceGenTcl::Ltspice::BasicDevices::SubcircuitInstance, ::SpiceGenTcl::Ltspice::BasicDevices::SubcircuitInstanceAuto, ::SpiceGenTcl::Ltspice::Sources::dc, ::SpiceGenTcl::Ltspice::Sources::ac, ::SpiceGenTcl::Ltspice::Sources::pulse, ::SpiceGenTcl::Ltspice::Sources::sin, ::SpiceGenTcl::Ltspice::Sources::exp, ::SpiceGenTcl::Ltspice::Sources::pwl, ::SpiceGenTcl::Ltspice::Sources::sffm, ::SpiceGenTcl::Ltspice::Sources::BehaviouralSource, ::SpiceGenTcl::Ltspice::SemiconductorDevices::Diode, ::SpiceGenTcl::Ltspice::SemiconductorDevices::Bjt, ::SpiceGenTcl::Ltspice::SemiconductorDevices::Jfet, ::SpiceGenTcl::Ltspice::SemiconductorDevices::Mesfet, ::SpiceGenTcl::Ltspice::SemiconductorDevices::Mosfet
constructor¶
Creates object of class Device.
Device create OBJNAME ?args? Device new ?args?
Parameters
name:Name of the device.
params:List of instance parameters in form
{{Name Value ?-sw|pos|eq|poseq|posnocheck|nocheck?} {Name Value ?-sw|pos|eq|poseq|posnocheck|nocheck?} {Name Value ?-sw|pos|eq|poseq|posnocheck|nocheck?} ...}Parameter list can be empty if device doesn’t have instance parameters.pins:List of pins in the order they appear in SPICE device’s definition together with connected node in form:
{{Name0 NodeName} {Name1 NodeName} {Name2 NodeName} ...}Nodes string values could be empty.
Description
Class models general device in SPICE, number of which must be assembled (connected) to get the circuit to simulate. This class provides basic machinery for creating any device that can be connected to net in circuit. It can be instantiated to create device that contains:
reference name, like
R1,L1,M1, etc;list of pins in the order of appearence of device’s definition, for example, ‘drain gate source’ for MOS transistor;
list of parameters, that could be positional (+equation), keyword (+equation) parameters, like
R1 nm np 100 tc1=1 tc2={tc0*tc12}, where100- positional parameter,tc1- keyword parameters andtc2keyword parameter with equation
This class accept definition that contains elements listed above, and generates classes: Pin,
Parameter, ParameterPositional with compositional relationship.
Each parameter definition could be modified by optional flags:
- -pos:
Parameter has strict position and only
$valueis displayed in netlist.- -eq:
Parameter may contain equation in terms of functions and other parsmeters, printed as
$name={$equation}- -poseq:
Combination of both flags, print only
{$equation}- -posnocheck:
Positional parameter without check.
- -nocheck:
Normal parameter without check.
destructor¶
Destroy object of class Device, its Parameter and Pin objects.
DEVICEOBJ destroy
actOnParam¶
Acts on Parameter object with selected action
OBJECT actOnParam -add ?-pos|eq|poseq|posnocheck|nocheck|sw|node|nodeeq? name value OBJECT actOnParam -set name value ?name value ...? OBJECT actOnParam -get name OBJECT actOnParam -get -all OBJECT actOnParam -delete name
Parameters
-add:Add new parameter to the device, requires
pnameargument.-all:Option for getting the dictionary that contains parameters names as keys and parameters values # as the dictionary values, requires
-get-delete:Delete existing parameter.
-eq:Parameter may contain equation in terms of functions and other parameters, printed as
$name={$equation}, requires-add-get:Get parameter value, requires
pnameargument.-nocheck:Normal parameter without check, requires
-add-node:Node parameter, requires
-add-nodeeq:Node parameter equation, requires
-add-pos:Parameter has strict position and only
$valueis displayed in netlist, requires-add-poseq:Combination of both flags, print only, requires
-add-posnocheck:Positional parameter without check, requires
-add-set:Set (or change) value of particular parameters, requires
pnameandvaluearguments.-sw:Switch parameter, requires
-addarguments:Optional pairs of name-value for
-setaction, requires-setpname:Name of parameter.
value:Value of parameter.
actOnPin¶
Acts on Pin object with selected action
OBJECT actOnPin -add pin node OBJECT actOnPin -set pin node OBJECT actOnPin -get pin OBJECT actOnPin -get -all
Parameters
-add:Add new pin to the device, requires
pinandnodearguments.-all:Option for getting the dictionary that contains pin name as keys and connected node name as the values, requires
-get-get:Get node name connected to pin, requires
pinargument.-set:Set node name connected to pin, requires
pinandnodearguments.node:Name of the node connected to pin.
pin:Name of the pin.
checkFloatingPins¶
Check if some pin device doesn’t have connected nodes and return list of them.
DEVICEOBJ checkFloatingPins ?args?
Parameters
Return value
list of floating pins
genSPICEString¶
Creates device string for SPICE netlist.
DEVICEOBJ genSPICEString
Return value
SPICE netlist’s string
EmptyTrace¶
Method summary
- configure
Configure properties. See ::oo::configuresupport::configurable.
- appendDataPoints
Inherited from Dataset.
- getStr
Inherited from Dataset.
- setDataPoints
Inherited from Dataset.
- getDataPoints
Not documented.
Properties
-len:Readable, writable. Inherited.
-name:Readable, writable. Inherited.
-numtype:Readable, writable. Inherited.
-type:Readable, writable. Inherited.
Superclasses
getDataPoints¶
EMPTYTRACEOBJ getDataPoints
Function¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates func string for SPICE netlist.
Properties
-body:Readable, writable.
-declaration:Readable, writable.
-name:Readable, writable.
Superclasses
constructor¶
Creates object of class Function.
OBJECT constructor declaration body ?-name value?
Parameters
-name value:Name of the string that could be used to retrieve element from ::SpiceGenTcl::Netlist object and its descendants, optional.
body:Body of the function.
declaration:Function declaration.
Description
This class represent .func statement.
genSPICEString¶
Creates func string for SPICE netlist.
FUNCTIONOBJ genSPICEString
Return value
SPICE netlist’s string
Global¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- addNets
Not documented.
- deleteNet
Not documented.
- genSPICEString
Creates
.globalstatement string for SPICE netlist.
Properties
-name:Readable, writable.
Superclasses
Mixins
constructor¶
Creates object of class Global.
OBJECT constructor nets ?-name value?
Parameters
-name value:Name of the library that could be used to retrieve element from ::SpiceGenTcl::Netlist object and its descendants, optional.
nets:List of nets in form
{net0 net1 ...}
Description
Class represent .global statement.
addNets¶
GLOBALOBJ addNets ?args?
Parameters
deleteNet¶
GLOBALOBJ deleteNet ?args?
Parameters
genSPICEString¶
Creates .global statement string for SPICE netlist.
GLOBALOBJ genSPICEString
Return value
SPICE netlist’s string
Ic¶
Method summary
- constructor
Constructor for the class.
- destructor
Destructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- actOnParam
Acts on
Parameterobject with selected action.- genSPICEString
Creates
.icstatement string for SPICE netlist.
Properties
-name:Readable, writable.
Superclasses
Mixins
Subclasses
constructor¶
Creates object of class Ic.
OBJECT constructor params ?-name value?
Parameters
-name value:Name of the library that could be used to retrieve element from ::SpiceGenTcl::Netlist object and its descendants, optional.
params:List of instance parameters in form
{{name value} {name value} {name equation -eq} ...}
Description
Class represent .ic statement.
destructor¶
Destroy object of class Ic, and its Parameter objects.
ICOBJ destroy
actOnParam¶
Acts on Parameter object with selected action
OBJECT actOnParam -add ?-pos|eq|poseq|posnocheck|nocheck|sw|node|nodeeq? name value OBJECT actOnParam -set name value ?name value ...? OBJECT actOnParam -get name OBJECT actOnParam -get -all OBJECT actOnParam -delete name
Parameters
-add:Add new parameter to the device, requires
pnameargument.-all:Option for getting the dictionary that contains parameters names as keys and parameters values # as the dictionary values, requires
-get-delete:Delete existing parameter.
-eq:Parameter may contain equation in terms of functions and other parameters, printed as
$name={$equation}, requires-add-get:Get parameter value, requires
pnameargument.-nocheck:Normal parameter without check, requires
-add-node:Node parameter, requires
-add-nodeeq:Node parameter equation, requires
-add-pos:Parameter has strict position and only
$valueis displayed in netlist, requires-add-poseq:Combination of both flags, print only, requires
-add-posnocheck:Positional parameter without check, requires
-add-set:Set (or change) value of particular parameters, requires
pnameandvaluearguments.-sw:Switch parameter, requires
-addarguments:Optional pairs of name-value for
-setaction, requires-setpname:Name of parameter.
value:Value of parameter.
genSPICEString¶
Creates .ic statement string for SPICE netlist.
ICOBJ genSPICEString
Return value
SPICE netlist’s string
Include¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates include string for SPICE netlist.
Properties
-name:Readable, writable. Inherited.
-value:Readable, writable. Inherited.
Superclasses
constructor¶
Creates object of class Include.
OBJECT constructor value ?-name value?
Parameters
-name value:Name of the string that could be used to retrieve element from ::SpiceGenTcl::Netlist object and its descendants, optional.
value:Value of the include path.
Description
This class represent .include statement.
genSPICEString¶
Creates include string for SPICE netlist.
INCLUDEOBJ genSPICEString
Return value
SPICE netlist’s string
Library¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates library string for SPICE netlist.
Properties
-libvalue:Readable, writable.
-name:Readable, writable. Inherited.
-value:Readable, writable. Inherited.
Superclasses
constructor¶
Creates object of class Library.
OBJECT constructor value libvalue ?-name value?
Parameters
-name value:Name of the string that could be used to retrieve element from ::SpiceGenTcl::Netlist object and its descendants, optional.
libvalue:Value of selected library.
value:Value of the include file.
Description
Class represent .lib statement.
genSPICEString¶
Creates library string for SPICE netlist.
LIBRARYOBJ genSPICEString
Return value
SPICE netlist’s string
Model¶
Method summary
- constructor
Constructor for the class.
- destructor
Destructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- actOnParam
Acts on
Parameterobject with selected action.- genSPICEString
Creates model string for SPICE netlist.
Properties
-name:Readable, writable.
-type:Readable, writable.
Superclasses
Mixins
Subclasses
::SpiceGenTcl::Ngspice::BasicDevices::RModel, ::SpiceGenTcl::Ngspice::BasicDevices::CModel, ::SpiceGenTcl::Ngspice::BasicDevices::LModel, ::SpiceGenTcl::Ngspice::BasicDevices::VSwitchModel, ::SpiceGenTcl::Ngspice::BasicDevices::CSwitchModel, ::SpiceGenTcl::Ngspice::SemiconductorDevices::DiodeModel, ::SpiceGenTcl::Ngspice::SemiconductorDevices::BjtGPModel, ::SpiceGenTcl::Ngspice::SemiconductorDevices::Jfet1Model, ::SpiceGenTcl::Ngspice::SemiconductorDevices::Jfet2Model, ::SpiceGenTcl::Ngspice::SemiconductorDevices::Mesfet1Model, ::SpiceGenTcl::Xyce::BasicDevices::RModel, ::SpiceGenTcl::Xyce::BasicDevices::CModel, ::SpiceGenTcl::Xyce::BasicDevices::LModel, ::SpiceGenTcl::Xyce::BasicDevices::VSwitchModel, ::SpiceGenTcl::Xyce::BasicDevices::CSwitchModel, ::SpiceGenTcl::Xyce::SemiconductorDevices::DiodeModel, ::SpiceGenTcl::Xyce::SemiconductorDevices::BjtGPModel, ::SpiceGenTcl::Xyce::SemiconductorDevices::Jfet1Model, ::SpiceGenTcl::Xyce::SemiconductorDevices::Jfet2Model, ::SpiceGenTcl::Xyce::SemiconductorDevices::Mesfet1Model, ::SpiceGenTcl::Ltspice::BasicDevices::VSwitchModel, ::SpiceGenTcl::Ltspice::BasicDevices::CSwitchModel, ::SpiceGenTcl::Ltspice::SemiconductorDevices::DiodeModel, ::SpiceGenTcl::Ltspice::SemiconductorDevices::DiodeIdealModel, ::SpiceGenTcl::Ltspice::SemiconductorDevices::BjtGPModel, ::SpiceGenTcl::Ltspice::SemiconductorDevices::JfetModel, ::SpiceGenTcl::Ltspice::SemiconductorDevices::MesfetModel
constructor¶
Creates object of class Model.
Model create OBJNAME ?args? Model new ?args?
Parameters
instParams:List of instance parameters in form
{{name value ?-pos|eq|poseq?} {name value ?-pos|eq|poseq?} {name value ?-pos|eq|poseq?} ...}name:Name of the model.
type:Type of model, for example,
diode,npn, etc.
Description
Class represents model card in SPICE netlist.
destructor¶
Destroy object of class Model, and its Parameter objects.
MODELOBJ destroy
actOnParam¶
Acts on Parameter object with selected action
OBJECT actOnParam -add ?-pos|eq|poseq|posnocheck|nocheck|sw|node|nodeeq? name value OBJECT actOnParam -set name value ?name value ...? OBJECT actOnParam -get name OBJECT actOnParam -get -all OBJECT actOnParam -delete name
Parameters
-add:Add new parameter to the device, requires
pnameargument.-all:Option for getting the dictionary that contains parameters names as keys and parameters values # as the dictionary values, requires
-get-delete:Delete existing parameter.
-eq:Parameter may contain equation in terms of functions and other parameters, printed as
$name={$equation}, requires-add-get:Get parameter value, requires
pnameargument.-nocheck:Normal parameter without check, requires
-add-node:Node parameter, requires
-add-nodeeq:Node parameter equation, requires
-add-pos:Parameter has strict position and only
$valueis displayed in netlist, requires-add-poseq:Combination of both flags, print only, requires
-add-posnocheck:Positional parameter without check, requires
-add-set:Set (or change) value of particular parameters, requires
pnameandvaluearguments.-sw:Switch parameter, requires
-addarguments:Optional pairs of name-value for
-setaction, requires-setpname:Name of parameter.
value:Value of parameter.
genSPICEString¶
Creates model string for SPICE netlist.
MODELOBJ genSPICEString
Return value
SPICE netlist’s string
Netlist¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- add
Adds elements objects to
Elementsdictionary.- del
Deletes elements from the netlist by its name.
- genSPICEString
Creates netlist string for SPICE netlist.
- getAllElemNames
Gets names of all elements in netlist.
- getElement
Gets particular element object reference by its name.
Properties
-name:Readable, writable.
Superclasses
Mixins
Subclasses
constructor¶
Creates object of class Netlist.
Netlist create OBJNAME ?args? Netlist new ?args?
Parameters
name:Name of the netlist.
Description
Class implements netlist as a collection of SPICE elements. Any element that has SPICEElement as a parent
class can be added to Netlist, except Options and Analysis.
add¶
Adds elements objects to Elements dictionary.
OBJECT add element ?element ...?
Parameters
elements:Elements objects references.
del¶
Deletes elements from the netlist by its name.
OBJECT del elementName ?elementName ...?
Parameters
elementsNames:Names of elements to delete.
genSPICEString¶
Creates netlist string for SPICE netlist.
NETLISTOBJ genSPICEString
Return value
SPICE netlist’s string
getAllElemNames¶
Gets names of all elements in netlist.
NETLISTOBJ getAllElemNames ?args?
Parameters
Return value
list of elements names
getElement¶
Gets particular element object reference by its name.
OBJECT getElement elemName
Parameters
elemName:Name of element.
Nodeset¶
Method summary
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates
.nodesetstatement string for SPICE netlist.- actOnParam
Inherited from Ic.
Properties
-name:Readable, writable. Inherited.
Superclasses
Mixins
genSPICEString¶
Creates .nodeset statement string for SPICE netlist.
NODESETOBJ genSPICEString
Return value
SPICE netlist’s string
Options¶
Method summary
- constructor
Constructor for the class.
- destructor
Destructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- actOnParam
Acts on
Parameterobject with selected action.- genSPICEString
Creates options string for SPICE netlist.
Properties
-name:Readable, writable.
Superclasses
Mixins
Subclasses
::SpiceGenTcl::Ngspice::Misc::OptionsNgspice
constructor¶
Creates object of class Options.
OBJECT constructor params ?-name value?
Parameters
-name value:Name of the string that could be used to retrieve element from ::SpiceGenTcl::Netlist object and its descendants, optional.
params:List of instance parameters in form
{{name value ?-sw?} {name value ?-sw?} {name value ?-sw?} ...}
Description
This class represent .options statement.
destructor¶
Destroy object of class Options, and its Parameter objects.
OPTIONSOBJ destroy
actOnParam¶
Acts on Parameter object with selected action
OBJECT actOnParam -add ?-pos|eq|poseq|posnocheck|nocheck|sw|node|nodeeq? name value OBJECT actOnParam -set name value ?name value ...? OBJECT actOnParam -get name OBJECT actOnParam -get -all OBJECT actOnParam -delete name
Parameters
-add:Add new parameter to the device, requires
pnameargument.-all:Option for getting the dictionary that contains parameters names as keys and parameters values # as the dictionary values, requires
-get-delete:Delete existing parameter.
-eq:Parameter may contain equation in terms of functions and other parameters, printed as
$name={$equation}, requires-add-get:Get parameter value, requires
pnameargument.-nocheck:Normal parameter without check, requires
-add-node:Node parameter, requires
-add-nodeeq:Node parameter equation, requires
-add-pos:Parameter has strict position and only
$valueis displayed in netlist, requires-add-poseq:Combination of both flags, print only, requires
-add-posnocheck:Positional parameter without check, requires
-add-set:Set (or change) value of particular parameters, requires
pnameandvaluearguments.-sw:Switch parameter, requires
-addarguments:Optional pairs of name-value for
-setaction, requires-setpname:Name of parameter.
value:Value of parameter.
genSPICEString¶
Creates options string for SPICE netlist.
OPTIONSOBJ genSPICEString
Return value
SPICE netlist’s string
Parameter¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates string for SPICE netlist.
Properties
-name:Readable, writable. Inherited.
-value:Readable, writable.
Superclasses
Subclasses
ParameterNode, ParameterNoCheck, ParameterPositional, ParameterDefault, ParameterEquation
constructor¶
Creates object of class Parameter with parameter name and value.
Parameter create OBJNAME ?args? Parameter new ?args?
Parameters
name:Name of the parameter.
value:Value of the parameter.
Description
Class models parameter that has a name and a value - the most common type of parameters in SPICE
netlist. Its representation in netlist is name=value, and can be called “keyword parameter”.
genSPICEString¶
Creates string for SPICE netlist.
PARAMETEROBJ genSPICEString
Return value
SPICE netlist’s string
ParameterDefault¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Inherited from Parameter.
- resetValue
Resets value of the parameter to it’s default value.
Properties
-defvalue:Readable, writable.
-name:Readable, writable. Inherited.
-value:Readable, writable. Inherited.
Superclasses
constructor¶
Creates object of class ParameterDefault with parameter name, value and default value.
ParameterDefault create OBJNAME ?args? ParameterDefault new ?args?
Parameters
defValue:Default value of the parameter.
name:Name of the parameter.
value:Value of the parameter.
Description
Class models parameter that has a name and a value, but it differs from parent class in sense of having
default value, so it has special ability to reset its value to default value by special method
resetValue.
resetValue¶
Resets value of the parameter to it’s default value.
PARAMETERDEFAULTOBJ resetValue ?args?
Parameters
ParameterEquation¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates string for SPICE netlist.
Properties
-name:Readable, writable. Inherited.
-value:Readable, writable.
Superclasses
Subclasses
constructor¶
Creates object of class ParameterEquation with parameter name and value as an equation.
ParameterEquation create OBJNAME ?args? ParameterEquation new ?args?
Parameters
name:Name of the parameter.
value:Value of the parameter.
Description
Class models parameter that has representation as an equation.
Example: R={R1+R2}
genSPICEString¶
Creates string for SPICE netlist.
PARAMETEREQUATIONOBJ genSPICEString
Return value
SPICE netlist’s string
ParameterNoCheck¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Inherited from Parameter.
Properties
-name:Readable, writable. Inherited.
-value:Readable, writable.
Superclasses
constructor¶
Creates object of class ParameterNoCheck with parameter name and value.
ParameterNoCheck create OBJNAME ?args? ParameterNoCheck new ?args?
Parameters
name:Name of the parameter.
value:Value of the parameter.
Description
Class models parameter the same as described by Parameter but without check for value form.
ParameterNode¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates string for SPICE netlist.
Properties
-name:Readable, writable.
-value:Readable, writable. Inherited.
Superclasses
Subclasses
constructor¶
Creates object of class ParameterNode with parameter name and value.
ParameterNode create OBJNAME ?args? ParameterNode new ?args?
Parameters
name:Name of the parameter.
value:Value of the parameter.
genSPICEString¶
Creates string for SPICE netlist.
PARAMETERNODEOBJ genSPICEString
Return value
SPICE netlist’s string
ParameterNodeEquation¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates string for SPICE netlist.
Properties
-name:Readable, writable. Inherited.
-value:Readable, writable. Inherited.
Superclasses
constructor¶
Creates object of class ParameterNodeEquation with parameter name and value.
ParameterNodeEquation create OBJNAME ?args? ParameterNodeEquation new ?args?
Parameters
name:Name of the parameter.
value:Value of the parameter.
genSPICEString¶
Creates string for SPICE netlist.
PARAMETERNODEEQUATIONOBJ genSPICEString
Return value
SPICE netlist’s string
ParameterPositional¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates string for SPICE netlist.
Properties
-name:Readable, writable. Inherited.
-value:Readable, writable. Inherited.
Superclasses
Subclasses
constructor¶
Creates object of class ParameterPositional with parameter name and value.
ParameterPositional create OBJNAME ?args? ParameterPositional new ?args?
Parameters
name:Name of parameter.
value:Value of parameter.
Description
Class models parameter that has a name and a value, but it differs from parent class in the sense of
netlist representation: this parameter represents only by the value in the netlist. It’s meaning for
holding element is taken from it’s position in the element’s definition, for example, R1 np nm 100 tc1=1
tc2=0 - resistor with positional parameter R=100, you can’t put it after parameters tc1 and tc2, it
must be placed right after the pins definition.
genSPICEString¶
Creates string for SPICE netlist.
PARAMETERPOSITIONALOBJ genSPICEString
Return value
SPICE netlist’s string
ParameterPositionalEquation¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates string for SPICE netlist.
Properties
-name:Readable, writable. Inherited.
-value:Readable, writable. Inherited.
Superclasses
constructor¶
Creates object of class ParameterPositionalEquation with parameter name and value as an equation in
positional form.
ParameterPositionalEquation create OBJNAME ?args? ParameterPositionalEquation new ?args?
Parameters
name:Name of the parameter.
value:Value of the parameter.
Description
Class models parameter that has representation as an equation, but in form of positional parameter.
Example: {R1+R2}
genSPICEString¶
Creates string for SPICE netlist.
PARAMETERPOSITIONALEQUATIONOBJ genSPICEString
Return value
SPICE netlist’s string
ParameterPositionalNoCheck¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates string for SPICE netlist. Results: SPICE netlist’s string.
Properties
-name:Readable, writable. Inherited.
-value:Readable, writable.
Superclasses
constructor¶
Creates object of class ParameterPositionalNoCheck.
ParameterPositionalNoCheck create OBJNAME ?args? ParameterPositionalNoCheck new ?args?
Parameters
name:Name of parameter.
value:Value of parameter.
Description
Class models parameter the same as described by ParameterPositional but without check for value form.
genSPICEString¶
Creates string for SPICE netlist. Results: SPICE netlist’s string
PARAMETERPOSITIONALNOCHECKOBJ genSPICEString
ParameterSwitch¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates string for SPICE netlist.
Properties
-name:Readable, writable.
-value:Readable, writable.
Superclasses
Subclasses
constructor¶
Creates object of class ParameterSwitch with parameter name.
ParameterSwitch create OBJNAME ?args? ParameterSwitch new ?args?
Parameters
name:Name of the parameter.
Description
Class models base parameter acting like a switch - its presence gives us information that something it
controls is on. This parameter doesn’t have a value, and it is the most basic class in Parameter class
family.
genSPICEString¶
Creates string for SPICE netlist.
PARAMETERSWITCHOBJ genSPICEString
Return value
string $name
ParameterVector¶
Method summary
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Inherited from ParameterSwitch.
Properties
-name:Readable, writable.
-value:Readable, writable. Inherited.
Superclasses
ParamStatement¶
Method summary
- constructor
Constructor for the class.
- destructor
Destructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- actOnParam
Acts on
Parameterobject with selected action.- genSPICEString
Creates parameter statement string for SPICE netlist.
Properties
-name:Readable, writable.
Superclasses
Mixins
constructor¶
Creates object of class ParamStatement.
OBJECT constructor params ?-name value?
Parameters
-name value:Name of the library that could be used to retrieve element from ::SpiceGenTcl::Netlist object and its descendants, optional.
params:List of instance parameters in form
{{name value ?-eq?} {name value ?-eq?} ...}
Description
Class represent .param statement.
destructor¶
Destroy object of class ParamStatement, and its Parameter objects.
PARAMSTATEMENTOBJ destroy
actOnParam¶
Acts on Parameter object with selected action
OBJECT actOnParam -add ?-pos|eq|poseq|posnocheck|nocheck|sw|node|nodeeq? name value OBJECT actOnParam -set name value ?name value ...? OBJECT actOnParam -get name OBJECT actOnParam -get -all OBJECT actOnParam -delete name
Parameters
-add:Add new parameter to the device, requires
pnameargument.-all:Option for getting the dictionary that contains parameters names as keys and parameters values # as the dictionary values, requires
-get-delete:Delete existing parameter.
-eq:Parameter may contain equation in terms of functions and other parameters, printed as
$name={$equation}, requires-add-get:Get parameter value, requires
pnameargument.-nocheck:Normal parameter without check, requires
-add-node:Node parameter, requires
-add-nodeeq:Node parameter equation, requires
-add-pos:Parameter has strict position and only
$valueis displayed in netlist, requires-add-poseq:Combination of both flags, print only, requires
-add-posnocheck:Positional parameter without check, requires
-add-set:Set (or change) value of particular parameters, requires
pnameandvaluearguments.-sw:Switch parameter, requires
-addarguments:Optional pairs of name-value for
-setaction, requires-setpname:Name of parameter.
value:Value of parameter.
genSPICEString¶
Creates parameter statement string for SPICE netlist.
PARAMSTATEMENTOBJ genSPICEString
Return value
SPICE netlist’s string
Parser¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- buildTopNetlist
Builds top netlist corresponding to parsed netlist file. For unknowns to
SpiceGenTclmodels the new model class is created during the parsing and evaluated in a caller context. For each subcircuit (and nested subcircuits) the corresponding class is created and evaluated in a caller context.- readAndParse
Calls methods
readFileandbuildTopNetlistin a sequence.- readFile
Not documented.
Properties
-definitions:Readable, writable.
-filepath:Readable, writable.
-name:Readable, writable.
-topnetlist:Readable, writable.
Subclasses
::SpiceGenTcl::Ngspice::NgspiceParser
constructor¶
Creates object of class Parser that do parsing of valid simulator netlist.
Parser create OBJNAME ?args? Parser new ?args?
Parameters
filepath:Path to file that should be parsed.
name:Name of the object.
buildTopNetlist¶
Builds top netlist corresponding to parsed netlist file.
For unknowns to SpiceGenTcl models the new model class is created during the parsing and evaluated in a
caller context. For each subcircuit (and nested subcircuits) the corresponding class is created and
evaluated in a caller context.
PARSEROBJ buildTopNetlist ?args?
Parameters
Return value
::SpiceGenTcl::Netlist object with attached elements succesfully parsed in input netlist file.
readAndParse¶
Calls methods readFile and buildTopNetlist in a sequence
PARSEROBJ readAndParse ?args?
Parameters
readFile¶
PARSEROBJ readFile
Pin¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- checkFloating
Determines if pin is connected to the node.
- genSPICEString
Creates string for SPICE netlist.
- unsetNodeName
Makes pin floating by setting name of the node to empty string.
Properties
-name:Readable, writable.
-node:Readable, writable.
Superclasses
constructor¶
Creates object of class Pin with name and connected node
OBJECT constructor name node
Parameters
name:Name of the pin.
node:Name of the node that connected to pin.
Description
Class models electrical pin of device/subcircuit, it has name and name of the node connected to it. It
has general interface method genSPICEString that returns name of the node connected to it, this method
must be called only in method with the same name in other classes. We can check if pin is floating by
checking the name of connected node in method checkFloating - if is contains empty string it is
floating. Floating pin can’t be netlisted, so it throws error when try to do so. Set pin name empty by
special method unsetNodeName.
checkFloating¶
Determines if pin is connected to the node.
PINOBJ checkFloating ?args?
Parameters
Return value
true if connected and false if not
genSPICEString¶
Creates string for SPICE netlist.
PINOBJ genSPICEString
Return value
SPICE netlist’s string
unsetNodeName¶
Makes pin floating by setting name of the node to empty string.
PINOBJ unsetNodeName ?args?
Parameters
RawFile¶
Method summary
- constructor
Constructor for the class.
- destructor
Destructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- readComplex
Inherited from BinaryReader.
- readFloat32
Inherited from BinaryReader.
- readFloat64
Inherited from BinaryReader.
- skip4bytes
Inherited from BinaryReader.
- skip8bytes
Inherited from BinaryReader.
- skip16bytes
Inherited from BinaryReader.
- getCurrentsNames
Returns list that contains names of all current variables.
- getTrace
Returns
Traceobject reference by it’s name.- getTracesCsv
Returns string with csv formatting containing all data.
- getTracesData
Returns dictionary that contains all data in value and name as a key.
- getTracesStr
Returns information about all ``Trace``s in raw file in form of string.
- getVariablesNames
Returns list that contains names of all variables.
- getVoltagesNames
Returns list that contains names of all voltage variables.
- measure
Calls
measurecommand fromtclmeasurepackage. Arguments to-xnameand-dataare provided automatically with data of raw file.
Properties
-axis:Readable, writable.
-npoints:Readable, writable.
-nvariables:Readable, writable.
-path:Readable, writable.
-rawparams:Readable, writable.
Mixins
constructor¶
Creates RawFile object.
RawFile create OBJNAME ?args? RawFile new ?args?
Parameters
-shared value:Handle to shared simulator instance.
path:Path to raw file including it’s file name (provide empty string if
-sharedoption is provided)simulator:Simulator that produced this raw file, default is
ngspicetraces2read:List of traces that will be readed, default value is
*, that means reading all traces.
destructor¶
Destroy object of class RawFile, and its traces objects.
RAWFILEOBJ destroy
getCurrentsNames¶
Returns list that contains names of all current variables
RAWFILEOBJ getCurrentsNames ?args?
Parameters
Return value
Returns list that contains names of all current variables
getTrace¶
Returns Trace object reference by it’s name
RAWFILEOBJ getTrace traceName
Parameters
traceName:Not documented.
Return value
Returns Trace object reference by it’s name
getTracesCsv¶
Returns string with csv formatting containing all data
OBJECT getTracesCsv ?-all? ?-traces list? ?-sep value?
Parameters
-all:Select all traces, optional.
-sep:Separator of columns, default is comma, optional.
-traces:Select names of traces to return, optional.
Return value
Returns string with csv formatting containing all data
getTracesData¶
Returns dictionary that contains all data in value and name as a key
RAWFILEOBJ getTracesData ?args?
Parameters
Return value
Returns dictionary that contains all data in value and name as a key
getTracesStr¶
Returns information about all ``Trace``s in raw file in form of string
RAWFILEOBJ getTracesStr ?args?
Parameters
Return value
Returns information about all ``Trace``s in raw file in form of string
getVariablesNames¶
Returns list that contains names of all variables
RAWFILEOBJ getVariablesNames ?args?
Parameters
Return value
Returns list that contains names of all variables
getVoltagesNames¶
Returns list that contains names of all voltage variables
RAWFILEOBJ getVoltagesNames ?args?
Parameters
Return value
Returns list that contains names of all voltage variables
measure¶
Calls measure command from tclmeasure package. Arguments to
-xname and -data are provided automatically with data of raw file.
OBJECT measure args
Parameters
args:Arguments to
measurecommand.
RawString¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates raw string for SPICE netlist.
Properties
-name:Readable, writable.
-value:Readable, writable.
Superclasses
Subclasses
constructor¶
Creates object of class RawString.
OBJECT constructor value ?-name value?
Parameters
-name value:Name of the string that could be used to retrieve element from ::SpiceGenTcl::Netlist object and its descendants, optional.
value:Value of the raw string.
Description
Class represent arbitary string. It can be used to pass any string directly into netlist, for example, it can add elements that doesn’t have dedicated class.
genSPICEString¶
Creates raw string for SPICE netlist.
RAWSTRINGOBJ genSPICEString
Return value
SPICE netlists string
Save¶
Method summary
- constructor
Constructor for the class.
- destructor
Destructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- addVector
Adds new
ParameterVectorobject to the dictionaryVectors.- deleteVector
Deletes existing
ParameterVectorobject from dictionaryVectors.- genSPICEString
Creates
.savestatement string for SPICE netlist.- getVectors
Gets the dictionary of ``ParameterVector``s.
Properties
-name:Readable, writable.
Superclasses
Mixins
constructor¶
Creates object of class ParamStatement.
OBJECT constructor vectors ?-name value?
Parameters
-name value:Name of the library that could be used to retrieve element from ::SpiceGenTcl::Netlist object and its descendants, optional.
vectors:List of vectors in form
{vec0 vec1 vec2 ...}
Description
Class represent .save statement.
destructor¶
Destroy object of class Save, and its ``ParameterVector``s objects.
SAVEOBJ destroy
addVector¶
Adds new ParameterVector object to the dictionary Vectors.
SAVEOBJ addVector ?args?
Parameters
vname:Name of vector.
deleteVector¶
Deletes existing ParameterVector object from dictionary Vectors.
SAVEOBJ deleteVector ?args?
Parameters
vname:Name of parameter that will be deleted.
genSPICEString¶
Creates .save statement string for SPICE netlist.
SAVEOBJ genSPICEString
Return value
SPICE netlist’s string
getVectors¶
Gets the dictionary of ``ParameterVector``s
SAVEOBJ getVectors ?args?
Parameters
Return value
vectors dictionary
Simulator¶
Method summary
- configure
Configure properties. See ::oo::configuresupport::configurable.
- getLog
Returns log file of completed simulations.
- readData
Reads raw data file of last simulation.
- readLog
Reads log file of completed simulations.
- run
Runs simulation.
Properties
-data:Readable, writable.
-log:Readable, writable.
-name:Readable, writable.
Subclasses
::SpiceGenTcl::Ngspice::Simulators::Batch, ::SpiceGenTcl::Ngspice::Simulators::Shared, ::SpiceGenTcl::Xyce::Simulators::Batch, ::SpiceGenTcl::Ltspice::Simulators::Batch
getLog¶
Returns log file of completed simulations.
SIMULATOROBJ getLog
Return value
Returns log file of completed simulations.
readData¶
Reads raw data file of last simulation.
SIMULATOROBJ readData
readLog¶
Reads log file of completed simulations.
SIMULATOROBJ readLog
run¶
Runs simulation.
SIMULATOROBJ run
SPICEElement¶
Method summary
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Declaration of method common for all SPICE elements that generates representation of element in SPICE netlist. Not implemented in abstraction class.
Subclasses
Pin, ParameterSwitch, Device, Model, RawString, Function, Options, ParamStatement, Save, Ic, Global, Temp, Netlist, Analysis
genSPICEString¶
Declaration of method common for all SPICE elements that generates representation of element in SPICE netlist. Not implemented in abstraction class.
SPICEELEMENTOBJ genSPICEString
Subcircuit¶
Method summary
- constructor
Constructor for the class.
- destructor
Destructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- actOnParam
Acts on
Parameterobject with selected action.- actOnPin
Acts on
Pinobject with selected action.- add
Add elements objects references to
Subcircuit, it extends add method to add check of element class becauseSubcircuitcan’t contain particular elements inside, like ::SpiceGenTcl::Include, ::SpiceGenTcl::Library, ::SpiceGenTcl::Options and ::SpiceGenTcl::Analysis.- genSPICEString
Creates subcircuit string for SPICE subcircuit.
- del
Inherited from Netlist.
- getAllElemNames
Inherited from Netlist.
- getElement
Inherited from Netlist.
Properties
-name:Readable, writable. Inherited.
Superclasses
constructor¶
Creates object of class Subcircuit.
Subcircuit create OBJNAME ?args? Subcircuit new ?args?
Parameters
name:Name of the subcircuit.
params:List of input parameters in form
{{name value} {name value} {name value} ...}pins:List of pins in the order they appear in SPICE subcircuits definition together in form:
{pinName0 pinName1 pinName2 ...}
Description
This class implements subcircuit, it is subclass of Netlist because it holds list of elements
inside subcircuit, together with header and connection of elements inside.
destructor¶
Destroy object of class Subcircuit, and its ``Parameter``s and ``Pin``s objects.
SUBCIRCUITOBJ destroy
actOnParam¶
Acts on Parameter object with selected action
OBJECT actOnParam -add ?-pos|eq|poseq|posnocheck|nocheck|sw|node|nodeeq? name value OBJECT actOnParam -set name value ?name value ...? OBJECT actOnParam -get name OBJECT actOnParam -get -all OBJECT actOnParam -delete name
Parameters
-add:Add new parameter to the device, requires
pnameargument.-all:Option for getting the dictionary that contains parameters names as keys and parameters values # as the dictionary values, requires
-get-delete:Delete existing parameter.
-eq:Parameter may contain equation in terms of functions and other parameters, printed as
$name={$equation}, requires-add-get:Get parameter value, requires
pnameargument.-nocheck:Normal parameter without check, requires
-add-node:Node parameter, requires
-add-nodeeq:Node parameter equation, requires
-add-pos:Parameter has strict position and only
$valueis displayed in netlist, requires-add-poseq:Combination of both flags, print only, requires
-add-posnocheck:Positional parameter without check, requires
-add-set:Set (or change) value of particular parameters, requires
pnameandvaluearguments.-sw:Switch parameter, requires
-addarguments:Optional pairs of name-value for
-setaction, requires-setpname:Name of parameter.
value:Value of parameter.
actOnPin¶
Acts on Pin object with selected action
OBJECT actOnPin -add pin node OBJECT actOnPin -set pin node OBJECT actOnPin -get pin OBJECT actOnPin -get -all
Parameters
-add:Add new pin to the device, requires
pinandnodearguments.-all:Option for getting the dictionary that contains pin name as keys and connected node name as the values, requires
-get-get:Get node name connected to pin, requires
pinargument.-set:Set node name connected to pin, requires
pinandnodearguments.node:Name of the node connected to pin.
pin:Name of the pin.
add¶
Add elements objects references to Subcircuit, it extends add method to add check of element class
because Subcircuit can’t contain particular elements inside, like ::SpiceGenTcl::Include,
::SpiceGenTcl::Library, ::SpiceGenTcl::Options and ::SpiceGenTcl::Analysis.
SUBCIRCUITOBJ add ?args?
Parameters
args:Elements objects references.
genSPICEString¶
Creates subcircuit string for SPICE subcircuit.
SUBCIRCUITOBJ genSPICEString
Return value
SPICE netlist’s string
Temp¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- genSPICEString
Creates
.tempstatement string for SPICE netlist.
Properties
-name:Readable, writable.
-value:Readable, writable.
Superclasses
constructor¶
Creates object of class Temp.
OBJECT constructor value ?-eq?
Parameters
-eq:Optional parameter qualificator.
value:Value of the temperature.
Description
This class represent .temp statement with temperature value.
genSPICEString¶
Creates .temp statement string for SPICE netlist.
TEMPOBJ genSPICEString
Return value
SPICE netlist’s string
Trace¶
Method summary
- constructor
Constructor for the class.
- configure
Configure properties. See ::oo::configuresupport::configurable.
- appendDataPoints
Inherited from Dataset.
- getDataPoints
Inherited from Dataset.
- getStr
Inherited from Dataset.
- setDataPoints
Inherited from Dataset.
Properties
-axis:Readable, writable.
-len:Readable, writable. Inherited.
-name:Readable, writable. Inherited.
-numtype:Readable, writable. Inherited.
-type:Readable, writable. Inherited.
Superclasses
constructor¶
Initializes Trace object.
Trace create OBJNAME ?args? Trace new ?args?
Parameters
axis:Name of axis that is linked to trace.
len:Total number of points.
name:Name of the trace.
numtype:Numerical type of trace.
type:Type of trace.
Utility¶
Method summary
Subclasses
Device, Model, Options, ParamStatement, Save, Ic, Nodeset, Global, Netlist, Analysis, RawFile, ::SpiceGenTcl::Common::Sources::pulse, ::SpiceGenTcl::Common::Sources::sin, ::SpiceGenTcl::Common::Sources::exp, ::SpiceGenTcl::Common::Sources::sffm, ::SpiceGenTcl::Common::Analyses::Dc, ::SpiceGenTcl::Common::Analyses::Ac, ::SpiceGenTcl::Common::Analyses::Tran, ::SpiceGenTcl::Common::Analyses::Op, ::SpiceGenTcl::Ngspice::Sources::pulse, ::SpiceGenTcl::Ngspice::Sources::sffm, ::SpiceGenTcl::Ngspice::Sources::am, ::SpiceGenTcl::Ngspice::Analyses::Sp, ::SpiceGenTcl::Ngspice::Analyses::SensAc, ::SpiceGenTcl::Ngspice::Analyses::SensDc, ::SpiceGenTcl::Ngspice::Misc::OptionsNgspice, ::SpiceGenTcl::Xyce::Analyses::Sens, ::SpiceGenTcl::Ltspice::Sources::pulse, ::SpiceGenTcl::Ltspice::Sources::sin, ::SpiceGenTcl::Ltspice::Sources::exp, ::SpiceGenTcl::Ltspice::Sources::sffm
Copyright (c) George Yashin