Reads a SIMetrix analysis parameter from the F11 window.
| Number | Type | Compulsory | Default | Description |
| 1 | String array | Yes | Parameter to search | |
| 2 | real | No | -1 | Schematic ID |
| 0 | Analysis type. Can be .TRAN, .AC, .DC, .NOISE or .TF |
| 1 | Parameter name - see below |
| 2 | Nest level for multistep analysis. If searching a parameter in the primary analysis, set this to -1 or omit altogether |
| name | description | analyses |
| stop_time | Stop time | Transient |
| time_step | Print step | Transient |
| start_time | Start data out time | Transient |
| max_time_step | Maximum time step | Transient |
| fast_time | Fast time | Transient |
| startup_time | Startup ramp time | Transient |
| uic | Boolean: Skip DC operating point | Transient |
| rtnstep | Real time noise time step | Transient |
| rtnmode | Integer: Real time noise mode | Transient |
| rtnstop | Real time noise stop time | Transient |
| snapstep | Vector: Snapshot step values | Transient |
| snapmode | Snapshot mode | Transient |
| snapshot | Vector: snapshot list values | Transient |
| pauseatend | Boolean: Pause at end of simulation | Transient |
| dec | Vector: decade sweep parameters | DC,AC,TF,Noise,Multistep |
| lin | Vector: linear sweep parameters | DC,AC,TF,Noise,Multistep |
| oct | Vector: ocal sweep parameters | DC,AC,TF,Noise,Multistep |
| list | Vector: Value list for list interval type | DC,AC,TF,Noise,Multistep |
| start_value | Start sweep value | DC,AC,TF,Noise,Multistep |
| stop_value | End sweep value | DC,AC,TF,Noise,Multistep |
| step_size | Sweep step size | DC,AC,TF,Noise,Multistep |
| num_points | Integer: Sweep number of points | DC,AC,TF,Noise,Multistep |
| device_name | String: Device reference for device sweep | DC,AC,TF,Noise,Multistep |
| parameter_name | String: Parameter name for parameter sweep | DC,AC,TF,Noise,Multistep |
| mode | String: Sweep or multistep mode | DC,AC,TF,Noise,Multistep |
| type | String: Interval type: dec, oct, lin, list | DC,AC,TF,Noise,Multistep |
| monte | Number of Monte Carlo trials | DC,AC,TF,Noise,Multistep |
| nomclog | Boolean: Monte Carlo log disabled | DC,AC,TF,Noise,Multistep |
| frequency | Fixed frequency for sweep modes | AC,TF,Noise,Multistep |
| output_node | String: Output node | Noise, TF |
| ref_node | String: Reference node | Noise, TF |
| source | String: Input source | Noise, TF |
| group_curves | Boolean: Group digital curves for multistep | Multistep |
| num_cores | Integer: Number of cores for multistep | Multistep |
| output_type | String: Voltage/current TF mode | TF |
| writedcop | Boolean: DCOP data written | AC,TF,Noise |
mode can have values "device", "parameter", "model_parameter", "temperature", "frequency" "monte_carlo", "snapshot", "sensitivity", "worstcase"
type can have values "decade", "octal", "linear", "step", "list"
Schematic ID as returned by OpenSchematic . This makes it possible to apply this function to any schematic and not just the one that is currently displayed. See OpenSchematic for more details.
| 0 | valid string result |
| 1 | valid real result |
| 2 | valid integer |
| 3 | valid boolean |
| 4 | valid real vector |
| 5 | parameter not set. This means that the parameter name give was valid but was not specified in the analysis statement and will take a default value |
| 6 | parameter not found. The paremeter name was not recognised for the specified analysis type |
The second and subsequent elements provide the parameter's value. Most parameters are scalar so there is just a single value in the second element. Vector parameters will use subsequent elements
If the parameter has a string value, the return value of the function will be a string. Otherwise the return value will be real. (integer and boolean values are returned as reals)
| ▲Function Summary▲ | ||
| ◄ ReadF11Analyses | ReadF11Options ▶ | |