kafka_dae_control.data

Data class containing the state of the program.

Members

Data

Create a new model by parsing and validating input data from keyword arguments.

class kafka_dae_control.data.Data(*, running: bool = False, title: str = '', users: str = '', job_id: str = '', run_number: int = 0, blocks: list[str] = <factory>, instrument_name: str = <factory>)[source]

Bases: BaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

blocks: list[str]

List of blocks to be inserted in the run start nexus structure. These are prefixed with the instrument and block server prefixes

instrument_name: str

The name of the instrument

job_id: str

Run’s job_id, used to tie starts and stops together

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

run_number: int

Run number

running: bool

Whether the hardware is running or not

title: str

Run title

users: str

Run users