::SpiceGenTcl::Ltspice::BasicDevicesTop, Main, Index

method constructor {name npNode nmNode args} {

    # Creates object of class `Capacitor` that describes capacitor.
    #  name - name of the device without first-letter designator C
    #  npNode - name of node connected to positive pin
    #  nmNode - name of node connected to negative pin
    #  args - keyword instance parameters
    # Capacitor type could be specified with additional switch `-q` if we
    # want to model circuit's variable dependent capacitor.
    # Simple capacitor:
    # ```
    # Cnnn n1 n2 <capacitance> [ic=<value>]
    # + [Rser=<value>] [Lser=<value>] [Rpar=<value>]
    # + [Cpar=<value>] [m=<value>]
    # + [RLshunt=<value>] [temp=<value>]
    # ```
    # Example of class initialization as a simple capacitor:
    # ```
    # ::SpiceGenTcl::Ltspice::BasicDevices::Capacitor new 1 netp netm -r 1e-6 -temp {temp -eq}
    # ```
    # Behavioral capacitor with Q expression:
    # ```
    # Cnnn n1 n2 Q=<expression> [ic=<value>] [m=<value>]
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ltspice::BasicDevices::Capacitor new 1 netp netm -q "V(a)+V(b)+pow(V(c),2)"
    # ```
    # Synopsis: name npNode nmNode -c value ?-m value? ?-temp value? ?-ic value? ?-rser value? ?-lser value?
    #   ?-rpar value? ?-cpar value? ?-rlshunt value?
    # Synopsis: name npNode nmNode -q value ?-m value? ?-ic value? ?-rser value? ?-lser value? ?-rpar value?
    #   ?-cpar value? ?-rlshunt value?
    set arguments [argparse -inline {
        {-c= -forbid q}
        {-q= -forbid c}
        -m=
        {-temp= -forbid q}
        -ic=
        -rser=
        -lser=
        -rpar=
        -cpar=
        -rlshunt=
    }]
    set params {}
    if {[dexist $arguments c]} {
        set cVal [dget $arguments c]
        if {([llength $cVal]>1) && ([@ $cVal 1] eq {-eq})} {
            lappend params [list c [@ $cVal 0] -poseq]
        } else {
            lappend params [list c $cVal -pos]
        }
    } elseif {![dexist $arguments q]} {
        return -code error "Capacitor value must be specified with '-c value'"
    }
    if {[dexist $arguments q]} {
        set qVal [dget $arguments q]
        lappend params [list q $qVal -eq]
    }
    dict for {paramName value} $arguments {
        if {$paramName ni {c q}} {
            lappend params [list $paramName {*}$value]
        }
    }
    next c$name [list [list np $npNode] [list nm $nmNode]] $params
}

method constructor {name args} {

    # Creates object of class `CSwitchModel` that describes current switch model.
    #  name - name of the model
    #  args - keyword instance parameters
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ltspice::BasicDevices::CSwitchModel new cswmod -it 1 -ih 0.5 -ron 1 -roff 1e6
    # ```
    # Synopsis: name ?-option value ...?
    next $name csw [my argsPreprocess {it ih ron roff} {*}$args]
}

method constructor {name npNode nmNode args} {

    # Creates object of class `Inductor` that describes inductor.
    #  name - name of the device without first-letter designator L
    #  npNode - name of node connected to positive pin
    #  nmNode - name of node connected to negative pin
    #  args - keyword instance parameters
    # Inductor type could be specified with additional switches: `-beh` if we
    # want to model circuit's variable dependent inductor, or `-model modelName`
    # if we want to simulate inductor with model card.
    # Simple inductor:
    # ```
    # LYYYYYYY n+ n- <value> <m=val>
    # + <scale=val> <temp=val> <dtemp=val> <tc1=val>
    # + <tc2=val> <ic=init_condition>
    # ```
    # Example of class initialization as a simple inductor:
    # ```
    # ::SpiceGenTcl::Ngspice::BasicDevices::Inductor new 1 netp netm -l 1e-6 -tc1 1 -temp {temp -eq}
    # ```
    # Behavioral inductor:
    # ```
    # LYYYYYYY n+ n- L={expression} <tc1=val> <tc2=val>
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ngspice::BasicDevices::Inductor new 1 netp netm -l "V(a)+V(b)+pow(V(c),2)" -beh -tc1 1
    # ```
    # Inductor with model card:
    # ```
    # LYYYYYYY n+ n- <value> <mname> <nt=val> <m=val>
    # + <scale=val> <temp=val> <dtemp=val> <tc1=val>
    # + <tc2=val> <ic=init_condition>
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ngspice::BasicDevices::Inductor new 1 netp netm -l 1e-6 -model indm
    # ```
    # Synopsis: name npNode nmNode -l value ?-tc1 value? ?-tc2 value? ?-m value? ?-temp value|-dtemp value?
    #   ?-scale value? ?-ic value?
    # Synopsis: name npNode nmNode -beh -l value ?-tc1 value? ?-tc2 value?
    # Synopsis: name npNode nmNode -model value ?-l value? ?-temp value|-dtemp value? ?-m value? ?scale value?
    #   ?-ic value? ?-nt value? ?-tc1 value? ?-tc2 value?
    set arguments [argparse -inline {
        {-l= -forbid {flux hyst}}
        {-flux= -forbid {l hyst}}
        {-hyst -forbid {l flux} -reciprocal -require {hc br bs lm lg a n}}
        -m=
        -ic=
        -temp=
        -tc1=
        -tc2=
        -rser=
        -rpar=
        -cpar=
        -hc=
        -br=
        -bs=
        -lm=
        -lg=
        -a=
        -n=
    }]
    set params {}
    if {[dexist $arguments l]} {
        set lVal [dget $arguments l]
        if {([llength $lVal]>1) && ([@ $lVal 1] eq {-eq})} {
            lappend params [list l [@ $lVal 0] -poseq]
        } else {
            lappend params [list l $lVal -pos]
        }
    } elseif {![dexist $arguments flux] && ![dexist $arguments hyst]} {
        return -code error "Inductor value must be specified with '-l value'"
    }
    if {[dexist $arguments flux]} {
        set fluxVal [dget $arguments flux]
        lappend params [list flux [dget $arguments flux] -eq]
    }
    dict for {paramName value} $arguments {
        if {$paramName ni {l flux hyst}} {
            lappend params [list $paramName {*}$value]
        }
    }
    next l$name [list [list np $npNode] [list nm $nmNode]] $params
}

method constructor {name pins subName params} {

    # Creates object of class `SubcircuitInstance` that describes subcircuit instance.
    #  name - name of the device without first-letter designator X
    #  pins - list of pins {{pinName nodeName} {pinName nodeName} ...}
    #  subName - name of subcircuit definition
    #  params - {{paramName paramValue ?-eq?} {paramName paramValue ?-eq?}}
    # ```
    # Xxxx n1 n2 n3... <subckt name> [<parameter>=<expression>]
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ltspice::BasicDevices::SubcircuitInstance new 1 {{plus net1} {minus net2}} rcnet {{r 1} {c cpar -eq}}
    # ```
    set params [linsert $params 0 [list model $subName -posnocheck]]
    next x$name $pins $params
}

method constructor {subcktObj name nodes args} {

    # Creates object of class `SubcircuitInstanceAuto` that describes subcircuit instance with already created
    # subcircuit definition object.
    #  subcktObj - object of subcircuit that defines it's pins, subName and parameters
    #  nodes - list of nodes connected to pins in the same order as pins in subcircuit definition
    #   {nodeName1 nodeName2 ...}
    #  args - parameters as argument in form : -paramName {paramValue ?-eq?} -paramName {paramValue ?-eq?}
    # ```
    # Xxxx n1 n2 n3... <subckt name> [<parameter>=<expression>]
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ltspice::BasicDevices::SubcircuitInstanceAuto new $subcktObj 1 {net1 net2} -r 1 -c {cpar -eq}
    # ```
    # Synopsis: subcktObj name nodes ?-paramName {paramValue ?-eq?} ...?

    # check that inputs object class is Subcircuit
    if {![info object class $subcktObj "::SpiceGenTcl::Subcircuit"]} {
        set objClass [info object class $subcktObj]
        return -code error "Wrong object class '$objClass' is passed as subcktObj, should be '::SpiceGenTcl::Subcircuit'"
    }
    # get name of subcircuit
    set subName [$subcktObj configure -name]
    # get pins names of subcircuit
    set pinsNames [dict keys [$subcktObj getPins]]
    # check if number of pins in subcircuit definition matchs the number of supplied nodes
    if {[llength $pinsNames]!=[llength $nodes]} {
        return -code error "Wrong number of nodes '[llength $nodes]' in definition, should be '[llength $pinsNames]'"
    }
    # create list of pins and connected nodes
    foreach pinName $pinsNames node $nodes {
        lappend pinsList [list $pinName $node]
    }
    # get parameters names of subcircuit
    if {![catch {$subcktObj getParams}]} {
        set paramsNames [dict keys [$subcktObj getParams]]
        foreach paramName $paramsNames {
            lappend paramDefList -${paramName}=
        }
    }
    if {[info exists paramDefList]} {
        # create definition for argparse module for passing parameters as optional arguments
        set arguments [argparse -inline "
            [join $paramDefList \n]
        "]
        # create list of parameters and values from which were supplied by args
        dict for {paramName value} $arguments {
            lappend params [list $paramName {*}$value]
        }
    } else {
        set params {}
    }
    set params [linsert $params 0 [list model $subName -posnocheck]]
    next x$name $pinsList $params
}

method constructor {name args} {

    # Creates object of class `VSwitchModel` that describes voltage switch model.
    #  name - name of the model
    #  args - keyword instance parameters
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Ltspice::BasicDevices::VSwitchModel new swmod -vt 1 -vh 0.5 -ron 1 -roff 1e6
    # ```
    # Synopsis: name ?-option value ...?
    next $name sw [my argsPreprocess {vt vh ron roff lser vser ilimit} {*}$args]
}