Method setStepVar

SLiCAP/SLiCAPinstruction.py:727–760

Defines the step variable for parameter step types 'lin', 'log' and 'list'. :param stepVar: step variable :type stepVar: str, sympy.Symbol :Example: >>> # Create an instance of the instruction object >>> my_instr = instruction() >>> # Defin

(self, stepVar)

        return

    def setStepVar(self, stepVar):
        """
        Defines the step variable for parameter step types 'lin', 'log' and 'list'.

        :param stepVar: step variable
        :type stepVar: str, sympy.Symbol

        :Example:

        >>> # Create an instance of the instruction object
        >>> my_instr = instruction()
        >>> # Define the circuit parameter 'alpha' as step variable:
        >>> my_instr.setStepVar('alpha')
        >>> # Enable parameter stepping
        >>> my_instr.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.stepVar = stepVar
        self.checkStepVar()
        return

    def checkStepVar(self):
        """