Skip to main content

PortClass

Enum PortClass 

Source
pub enum PortClass {
    Conducting,
    ControlInput,
    Transducer(Domain),
    Rail,
}
Expand description

Device-agnostic classification of what a single port (a component.pin) is, derived entirely from existing model facts — no new annotation.

Variants§

§

Conducting

An ordinary current-conducting terminal that gets MNA/WDF-stamped: a tube plate / cathode, BJT collector / emitter, R/C/L pins, op-amp output. The default for anything that is not a control / transducer / rail port.

§

ControlInput

A high-impedance signal-control electrode: tube grid, BJT base, FET gate, op-amp inverting/non-inverting input. Derived from SignalTerminals::Amplifier input/control.

§

Transducer(Domain)

A transducer port that couples across a non-electrical Domain (photocoupler .led, OTA .iabc, VCA .cv, FET .vgs). Derived from Component::modulation_sink.

§

Rail

A supply / ground / AC-ground rail node. Derived from the graph rail sets. (A node property; from_component cannot see it, so it is supplied by PortClass::from_pin_in_graph.)

Implementations§

Source§

impl PortClass

Source

pub fn from_component(comp: &dyn Component, pin: &str) -> Self

Derive the class of pin on comp from the device model alone.

This is the component-fact half of the derivation (it cannot see graph nodes, so it never returns PortClass::Rail — use PortClass::from_pin_in_graph for the rail-aware classification).

Precedence (most-specific first):

  1. A pin that is a Component::modulation_sink is a transducer port — .led, .iabc, .cv, .vgs. (A FET’s vgs/gate IS a transducer port when read this way; that is the intended unification — the control electrode of an externally-modulated device is a transducer.)
  2. A pin that is the input or control of an SignalTerminals::Amplifier is a PortClass::ControlInput — grid / base / gate / op-amp pos+neg.
  3. Otherwise PortClass::Conducting.
Source

pub fn from_pin_in_graph( comp: &dyn Component, pin: &str, node: usize, graph: &CircuitGraph, ) -> Self

Rail-aware classification of comp.pin resolved against graph.

Identical to PortClass::from_component except a pin whose resolved node is a rail (gnd / vcc / named supply / AC-ground) returns PortClass::Rail. The rail check takes precedence because a terminal tied straight to a rail is electrically a rail port regardless of its device role.

Source

pub fn label(self) -> &'static str

Human-readable label for diagnostics.

Trait Implementations§

Source§

impl Clone for PortClass

Source§

fn clone(&self) -> PortClass

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for PortClass

Source§

impl Debug for PortClass

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for PortClass

Source§

impl Hash for PortClass

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for PortClass

Source§

fn eq(&self, other: &PortClass) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PortClass

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more