Method setStepVars

SLiCAP/SLiCAPinstruction.py:782–823

Defines the step variables for 'array' type stepping. :param stepVars: List with names (*str, sympy.Symbol*) of step variables for array type stepping. :type stepVars: list :Example: >>> # Create an instance of the instruction obje

(self, stepVars)

        return

    def setStepVars(self, stepVars):
        """
        Defines the step variables for 'array' type stepping.

        :param stepVars: List with names (*str, sympy.Symbol*) of step
                         variables for array type stepping.
        :type stepVars: list

        :Example:

        >>> # Create an instance of the instruction object
        >>> my_instr = instruction()
        >>> # check a netlist file and use the circuit from this file for this
        >>> # instruction:
        >>> my_instr.setCircuit('my_circuit.cir')
        >>> # Define 'array' type stepping:
        >>> my_instr.stepMethod = 'array'
        >>> # Define circuit parameters 'R_a' and 'C_a' as step variables:
        >>> my_instr.setStepVars(['R_a', 'C_a'])
        >>> Define the step values for 'R_a and 'C_a':
        >>> my_instr.setStepArray ([['1k', 1200, 1.2e3],['1u', 10e-6, 0.0001]])
        >>> # Enable parameter stepping
        >>> my_instruction.stepOn()

        :note:

        A list with names (*sympy.Symbol*) that can be used as stepping
        parameter is obtained as follows:

        :Example:

        >>> # Create an instance of the instruction object
        >>> my_instr = instruction()
        >>> # check a netlist file and use the circuit from this file for this
        >>> # instruction:
        >>> my_instr.setCircuit('my_circuit.cir')
        >>> # print the list with names of all parameters that can be stepped:
        >>> print instr.circuit.params + list(instr.circuit.parDefs.keys())
        """
        self.stepVars = stepVars
        self.checkStepVars()
        return

    def checkStepVars(self):
        """