Index

Type the index terms you want to search for in the text input field.
Matching terms will be shown incrementally as you type.
Press Enter to navigate to the target of the first displayed index entry.
Alternatively, Tab to move to the index entry of interest and then press Enter to navigate to that documentation page.
To jump to this page from any other documentation page, press browser-specific shortcut modifiers with i. For example, on IE and Edge this would be Alt-i while on Firefox and Chrome Alt-Shift-i. Other browsers and platforms may differ.

abort
```
abort 
```
Sets an internal abort flag and wake any waiters (useful to force waitevent to return). This does not free the instance.
::ngspicetclbridge
asyncvector
```
asyncvector ?-info? name
```
Fetches the current values of a named vector on demand via ngspice ngGet_Vec_Info. Works after the simulation has produced any data (not necessarily the complete vector). By addding -info switch, vector metadata is provided, i.e. type of the vector (current, voltage, time, etc), type of the numbers (complex or real), and length of the vector.
::ngspicetclbridge
circuit
```
circuit list
```
Sends an circuit to Ngspice in form of the list, each element is the lineof the netlist.
::ngspicetclbridge
command
```
command string
```
Sends an arbitrary Ngspice command line (e.g., bg_run, circbyline ..., .save, .tran, .dc). If we provide -capture switch, it returns not only the result code, but also the next message from stdout of Ngspice. Also, if command is send in the moment background thread is starting or stopping, it will be deferred to the time is could be safely sent, and in that case -capture message and command results code are not availaible as a return of command.
::ngspicetclbridge
destroy
```
destroy 
```
Deletes the instance command. In details:
::ngspicetclbridge
eventcounts
```
eventcounts ?-clear?
```
Gets or reset the cumulative event counters for this simulator instance.
::ngspicetclbridge
getCircuit
```
getCircuit ?-logical|-physical|-deck|-expand|-runnable|-param? sim
```
Gets list with currently loaded circuit (its listing) in the form specified by the switch.
::ngspicetclbridge
getCircuitTitle
```
getCircuitTitle sim
```
Gets title of the current circuit (first line of circuits netlist).
::ngspicetclbridge
getPlotDate
```
getPlotDate sim
```
Gets time stamp of current plot generation.
::ngspicetclbridge
getPlotName
```
getPlotName sim
```
Gets name of the current plot, i.e. Operating Point, AC Analysis, etc.
::ngspicetclbridge
getScaleInfo
```
getScaleInfo sim
```
Gets dictionary with information about current scale vector.
::ngspicetclbridge
initvectors
```
initvectors ?-clear?
```
Returns held initial vector metadata (built from send_init_data) in a dict. dict with initial vector metadata saved in internal structure
::ngspicetclbridge
inputpath
```
inputpath -current
inputpath path
```
Returns current path for XSPICE code models if -current switch is provided, or set current path to value provided. current path
::ngspicetclbridge
isrunning
```
isrunning 
```
Calls asynchronously to check if background thread is running.
::ngspicetclbridge
messages
```
messages ?-clear?
```
Queues of textual messages captured from Ngspice (stdout/stderr) and bridge status lines.
::ngspicetclbridge
new
```
new ?-nospinit|nospiceinit|noinit? libpath
```
Load dynamic library, path should be provided in native form for target OS. Every ::ngspicetclbridge::new returns a command (e.g. ::ngspicetclbridge::s1). The following subcommands operate on that instance. Optionally the spinit and/or spiceinit initialization files could be forbidden for loading.
::ngspicetclbridge
plot
```
plot -all
plot -vecs name
```
Returns current plot name if no arguments provided, names of all plots or all vectors names that belongs to name of the provided plot. current plot, or list of all plots, or list of all vectors
::ngspicetclbridge
readVecsAsync
```
readVecsAsync ?-info? sim
```
Reads all availible vectors of the current plot asynchronously and return dictionary with vector name as a key, and data as a value. If -info switch is provided, command returns information about each availiable vector.
::ngspicetclbridge
run
```
run sim
```
Runs simulation in background thread, waits for the completion, process event in the queue and returns
::ngspicetclbridge
vectors
```
vectors ?-clear?
```
Returns held synchronously accumulated vector values (built from send_data events) in a dict. dict with vectors values accumulated up to this point in internal structure
::ngspicetclbridge
waitevent
```
waitevent ?args?
```
Blocks until a named event is observed n number of times (or once), the instance is aborted/destroyed, or the timeout expires (if provided).
::ngspicetclbridge