STAR
Cal STAR — firmware, DAQ server, and engine design
Loading...
Searching...
No Matches
feedtwin.model.catalog.Part Class Reference

Public Member Functions

dict[str, Param] resolve (self)
dict[str, tuple[Param, Param]] disagreements (self, float tolerance=0.0)
dict[str, Any] to_dict (self)
Part from_dict (cls, str part_id, Mapping[str, Any] data)

Static Public Attributes

str manufacturer = ""
str description = ""
dict params = field(default_factory=dict)
dict measured = field(default_factory=dict)
dict curves = field(default_factory=dict)

Detailed Description

One catalogued piece of hardware.

Definition at line 49 of file catalog.py.

Member Function Documentation

◆ disagreements()

dict[str, tuple[Param, Param]] feedtwin.model.catalog.Part.disagreements ( self,
float tolerance = 0.0 ) 
Parameters where measurement and datasheet differ by more than
``tolerance`` (relative).

Worth surfacing rather than burying. A part that consistently measures
below its rating is either mis-specified, installed wrong, or the
datasheet is optimistic -- all three are findings, and all three are
invisible if the override silently replaces the original.

Definition at line 72 of file catalog.py.

References measured, feedtwin.comps.correlations.FittingContext.params, and params.

◆ from_dict()

Part feedtwin.model.catalog.Part.from_dict ( cls,
str part_id,
Mapping[str, Any] data )

Definition at line 108 of file catalog.py.

References feedtwin.model.catalog._curves(), and feedtwin.model.catalog._params().

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().

◆ resolve()

dict[str, Param] feedtwin.model.catalog.Part.resolve ( self) 
Datasheet values with measurements layered over them.

Definition at line 68 of file catalog.py.

References measured, feedtwin.comps.correlations.FittingContext.params, and params.

◆ to_dict()

dict[str, Any] feedtwin.model.catalog.Part.to_dict ( self)

Definition at line 91 of file catalog.py.

References actuator_testing_gui.ActuatorTestingWindow.curves, curves, gui.App.curves, lc_calibration_gui.LCPlotWindow.curves, description, manufacturer, measured, feedtwin.comps.correlations.FittingContext.params, params, anonymous_namespace{config_broadcast_service_main.cpp}::BoardInfo.type, array.type(), backend.routers.timeseries.PressureSegment.type, basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType, CustomBaseClass >.type, basic_json< nlohmann::ordered_map >.type, BoardConfig.type, default_value_traits.type, engine.pipeline.config_schemas.CoaxialInjectorConfig.type, engine.pipeline.config_schemas.ImpingingInjectorConfig.type, engine.pipeline.config_schemas.InjectorBaseConfig.type, engine.pipeline.config_schemas.PintleInjectorConfig.type, engine.pipeline.config_schemas.PressureSegmentConfig.type, feedtwin.comps.base.HydraulicComponent.type(), feedtwin.model.component.ComponentInstance.type(), feedtwin.model.spec.ComponentSpec.type, float_traits_base< T, MantissaDigits, DecimalDigits >.type, float_traits_base< double, std::numeric_limits< double >::digits, std::numeric_limits< double >::digits10 >.type, float_traits_base< float, std::numeric_limits< float >::digits, std::numeric_limits< float >::digits10 >.type, float_traits_base< long double, std::numeric_limits< long double >::digits, std::numeric_limits< long double >::digits10 >.type, float_traits_base< T, std::numeric_limits< T >::digits, std::numeric_limits< T >::digits10 >.type, fsw::config::BoardConfig.type, fsw::control::RobustDDPController::Command.type, fsw::control::RobustDDPController::Reference.type, integer_traits_base< T >.type, integer_traits_base< signed char >.type, integer_traits_base< signed int >.type, integer_traits_base< signed long >.type, integer_traits_base< signed long long >.type, integer_traits_base< signed short >.type, integer_traits_base< unsigned char >.type, integer_traits_base< unsigned int >.type, integer_traits_base< unsigned long >.type, integer_traits_base< unsigned long long >.type, integer_traits_base< unsigned short >.type, native_value_traits< T, NodeType >.type, native_value_traits< bool, node_type::boolean >.type, native_value_traits< date, node_type::date >.type, native_value_traits< date_time, node_type::date_time >.type, native_value_traits< time, node_type::time >.type, path_component.type(), radio_link::Frame.type, radio_rx_t.type, rec_t.type, string_traits< T >.type, string_traits< char * >.type, string_traits< char[N]>.type, string_traits< const char * >.type, string_traits< const char[N]>.type, string_traits< std::string >.type, string_traits< std::string_view >.type, and table.type().

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

Member Data Documentation

◆ curves

dict feedtwin.model.catalog.Part.curves = field(default_factory=dict)
static

Definition at line 58 of file catalog.py.

Referenced by feedtwin.model.spec.ComponentSpec.__post_init__(), to_dict(), feedtwin.model.component.ComponentInstance.to_dict(), and feedtwin.model.spec.ComponentSpec.validate_curves().

◆ description

str feedtwin.model.catalog.Part.description = ""
static

Definition at line 55 of file catalog.py.

Referenced by to_dict().

◆ manufacturer

str feedtwin.model.catalog.Part.manufacturer = ""
static

Definition at line 54 of file catalog.py.

Referenced by csv_to_eng.core.EngineMetadata.header_line(), and to_dict().

◆ measured

dict feedtwin.model.catalog.Part.measured = field(default_factory=dict)
static

Definition at line 57 of file catalog.py.

Referenced by disagreements(), resolve(), and to_dict().

◆ params

feedtwin.model.catalog.Part.params = field(default_factory=dict)
static

Definition at line 56 of file catalog.py.

Referenced by feedtwin.model.spec.ComponentSpec.__post_init__(), feedtwin.model.component.ComponentInstance.assumptions(), disagreements(), feedtwin.model.spec.ComponentSpec.params_for(), feedtwin.model.component.ComponentInstance.provenance(), resolve(), feedtwin.model.component.ComponentInstance.si(), feedtwin.model.component.ComponentInstance.si_params(), test_robust_ddp_dynamics.TestDynamics.test_blowdown_decreases_pressure(), test_robust_ddp_dynamics.TestDynamics.test_control_clamping(), test_robust_ddp_dynamics.TestDynamics.test_copv_blowdown(), test_robust_ddp_dynamics.TestDynamics.test_feed_pressure_lag(), test_robust_ddp_ddp_solver.TestDDPSolver.test_forward_rollout(), test_robust_ddp_dynamics.TestDynamics.test_linearize_accuracy(), test_robust_ddp_dynamics.TestDynamics.test_linearize_shape(), test_robust_ddp_dynamics.TestDynamics.test_pressurization_increases_pressure(), test_robust_ddp_dynamics.TestDynamics.test_state_non_negative(), test_robust_ddp_dynamics.TestDynamics.test_step_basic(), test_robust_ddp_robustness.TestRobustness.test_tube_propagate_basic(), test_robust_ddp_robustness.TestRobustness.test_tube_propagate_validation(), test_robust_ddp_robustness.TestRobustness.test_tube_propagate_widens(), test_robust_ddp_robustness.TestRobustness.test_tube_propagate_with_large_w_bar(), test_robust_ddp_dynamics.TestDynamics.test_ullage_volume_increases(), test_robust_ddp_dynamics.TestDynamics.test_zero_mass_flow(), to_dict(), feedtwin.model.component.ComponentInstance.to_dict(), and feedtwin.model.spec.ComponentSpec.validate().

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