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

Method setStepList

SLiCAP/SLiCAPinstruction.py:1040–1067  ·  view source on GitHub ↗

Defines the list with step values for step method 'list'. This list will be overwritten if the instruction is executed with the step method set to 'lin' or 'log'. :param stepList: List with step values for the step parameter. :type stepList: list :E

(self, stepList)

Source from the content-addressed store, hash-verified

1038 return
1039
1040 def setStepList(self, stepList):
1041 """
1042 Defines the list with step values for step method 'list'. This list will
1043 be overwritten if the instruction is executed with the step method set
1044 to 'lin' or 'log'.
1045
1046 :param stepList: List with step values for the step parameter.
1047 :type stepList: list
1048
1049 :Example:
1050
1051 >>> # Create an instance of the instruction object
1052 >>> my_instr = instruction()
1053 >>> # check a netlist file and use the circuit from this file for this
1054 >>> # instruction:
1055 >>> my_instr.setCircuit('my_circuit.cir')
1056 >>> # Define 'list' type stepping:
1057 >>> my_instr.setStepMethod('list')
1058 >>> # Define the circuit parameter 'alpha' as step parameter:
1059 >>> my_instr.setStepVar('alpha')
1060 >>> # Define a list of step values for this parameter.
1061 >>> my_instr.setStepList(['10m', '20m', '50m', 0.1, 0.2, 0.5, 1, 2, 5])
1062 >>> # Enable parameter stepping
1063 >>> my_instr.stepOn()
1064 """
1065 self.stepList = stepList
1066 self.checkStepList()
1067 return
1068
1069 def checkStepList(self):
1070 """

Callers

nothing calls this directly

Calls 1

checkStepListMethod · 0.95

Tested by

no test coverage detected