feedtwin.session.hookup.Hookup Class Reference

Public Member Functions
bool	wired (self)
Knob|None	knob_for (self, str regulator)
Channel|None	channel_of (self, str symbol)
dict[str, str]	names (self)
dict[str, Any]	to_dict (self)
"Hookup"	from_dict (cls, Mapping[str, Any] raw)

Static Public Attributes
Mapping	valves = field(default_factory=dict)
tuple	knobs = ()
Mapping	aliases = field(default_factory=dict)
tuple	channels = None
Mapping	rows = field(default_factory=dict)
frozenset	auto = frozenset()
StateMachine	machine = None

Detailed Description

What a person decided about one drawing's controls.

Definition at line 141 of file hookup.py.

Member Function Documentation

channel_of()

Channel | None feedtwin.session.hookup.Hookup.channel_of	(		self,
		str	symbol )

Definition at line 175 of file hookup.py.

References channels.

from_dict()

"Hookup" feedtwin.session.hookup.Hookup.from_dict	(		cls,
		Mapping[str, Any]	raw )

Definition at line 209 of file hookup.py.

References feedtwin.session.hookup._check_channels(), and max.

Referenced by engine.control.robust_ddp.data_models.ControllerConfig.from_json(), engine.control.robust_ddp.data_models.ControllerConfig.from_yaml(), and calibration_robustness.SystemConfig.load().

knob_for()

Knob | None feedtwin.session.hookup.Hookup.knob_for	(		self,
		str	regulator )

Definition at line 172 of file hookup.py.

References feedtwin.session.core.Session.knobs, and knobs.

names()

dict[str, str] feedtwin.session.hookup.Hookup.names

(

self

)

What the console calls each thing, by drawing id: a symbol on a
channel by the channel's name, anything else by its alias.

Definition at line 178 of file hookup.py.

References feedtwin.props.species.SpeciesSpec.aliases, aliases, and channels.

to_dict()

dict[str, Any] feedtwin.session.hookup.Hookup.to_dict

(

self

)

The stored form. A hookup of the old kind -- no box, no edited
table -- is written exactly as it always was (schema 1), so a run
recorded before the box existed and one recorded since diff clean.

Definition at line 186 of file hookup.py.

References feedtwin.props.species.SpeciesSpec.aliases, aliases, auto, channels, feedtwin.session.core.Session.knobs, knobs, feedtwin.session.core.Session.machine, machine, rows, to_dict(), and valves.

Referenced by calibration_robustness.SystemConfig.save(), to_dict(), engine.control.robust_ddp.data_models.ControllerConfig.to_json(), and engine.control.robust_ddp.data_models.ControllerConfig.to_yaml().

wired()

bool feedtwin.session.hookup.Hookup.wired

(

self

)

Definition at line 169 of file hookup.py.

References channels.

Member Data Documentation

aliases

feedtwin.session.hookup.Hookup.aliases = field(default_factory=dict)

static

Definition at line 147 of file hookup.py.

Referenced by names(), and to_dict().

auto

frozenset feedtwin.session.hookup.Hookup.auto = frozenset()

static

Definition at line 160 of file hookup.py.

Referenced by to_dict().

channels

tuple feedtwin.session.hookup.Hookup.channels = None

static

Definition at line 153 of file hookup.py.

Referenced by channel_of(), names(), to_dict(), and wired().

knobs

tuple feedtwin.session.hookup.Hookup.knobs = ()

static

Definition at line 146 of file hookup.py.

Referenced by knob_for(), and to_dict().

machine

StateMachine feedtwin.session.hookup.Hookup.machine = None

static

Definition at line 164 of file hookup.py.

Referenced by to_dict().

rows

Mapping feedtwin.session.hookup.Hookup.rows = field(default_factory=dict)

static

Definition at line 157 of file hookup.py.

Referenced by feed_line_K.Run.add(), feed_line_K.Run.report(), and to_dict().

valves

Mapping feedtwin.session.hookup.Hookup.valves = field(default_factory=dict)

static

Definition at line 144 of file hookup.py.

Referenced by to_dict().

---

The documentation for this class was generated from the following file:

• lib/feedtwin/feedtwin/session/hookup.py