Method setSource

SLiCAP/SLiCAPinstruction.py:1159–1202

Defines the signal source. :param source: Name of an independent voltage or current source that exists in the circuit. :type source: str :Example: >>> # Create an instance of the instruction object >>> my_instr = instruction(

(self, source)

    def setSource(self, source):
        """
        Defines the signal source.

        :param source: Name of an independent voltage or current source that
                       exists in the circuit.
        :type source: str

        :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 the voltage source 'V1' as signal source:
        >>> my_instr.setSource('V1')

        :note:

        A list with names of independent voltage and current sources that can be
        assigned as signal source can be obtained from the method:
        **instruction.indepVars()**:

        :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')
        >>> # Obtaine a list with names of independent sources:
        >>> my_instr.circuit.indepVars()
        """
        if type(source) == str:
            self.source = [source, None]
            self.checkSource()
        elif type(source) == list and len(source) == 2:
            self.source = source
            self.checkSource()
        else:
            print("Error in loop gain reference specification.")
        self.checkSource(need = False)
        return

    def checkSource(self, need = True):
        """