::SpiceGenTcl::Xyce::SourcesTop, Main, Index

method constructor {args} {

    # Creates object of class `BehaviouralSource` that describes behavioural source.
    #  name - name of the device without first-letter designator B
    #  np - name of node connected to positive pin
    #  nm - name of node connected to negative pin
    #  -i - current expression
    #  -v - voltage expression
    #  -smoothbsrc - enables the smooth transitions, optional, require -v
    #  -rcconst - rc constant of the RC network, optional, require -v
    # ```
    # B<name> <(+) node> <(-) node> V={expression} [device parameters]
    # B<name> <(+) node> <(-) node> I={expression}
    # ```
    # Example of class initialization:
    # ```
    # ::SpiceGenTcl::Xyce::Sources::BehaviouralSource new 1 netp netm -v "V(a)+V(b)+pow(V(c),2)"
    # ```
    # Synopsis: name np nm -i value
    # Synopsis: name np nm -v value ?-smoothbsrc? ?-rcconst value?
    set arguments [argparse -inline -pfirst -help {Creates object of class 'BehaviouralSource' that describes behavioural source} {
        {-i= -forbid {v} -help {Current expression}}
        {-v= -forbid {i} -help {Voltage expression}}
        {-smoothbsrc -require {v} -help {Enables the smooth transitions}}
        {-rcconst= -require {v} -help {RC constant of the RC network}}
        {name -help {Name of the device without first-letter designator}}
        {np -help {Name of node connected to positive pin}}
        {nm -help {Name of node connected to negative pin}}
    }]
    if {[dexist $arguments i]} {
        lappend params [list i [dget $arguments i] -eq]
    } elseif {[dexist $arguments v]} {
        lappend params [list v [dget $arguments v] -eq]
    } else {
        return -code error "Equation must be specified as argument to -i or -v"
    }
    if {[dexist $arguments smoothbsrc]} {
        lappend params {smoothbsrc 1}
    }
    if {[dexist $arguments rcconst]} {
        lappend params [list rcconst [dget $arguments rcconst]]
    }
    next b[dget $arguments name] [list [list np [dget $arguments np]] [list nm [dget $arguments nm]]] $params
}