mxcubeweb.core.models.adaptermodels

Classes

Base64StrModel(*[, value])
BeamlineActionInputModel(*, cmd, parameters)
FloatValueModel(*[, value])
FrontEndStackTraceModel(*, stack, state)
HOActuatorModel(*[, name, state, msg, type, ...])
HOActuatorValueChangeModel(*[, name, value])
HOBeamModel(*[, name, state, msg, type, ...])
HOBeamValueModel(*[, apertureList, ...])
HOMachineInfoModel(*[, name, state, msg, ...])
HOModel(*[, name, state, msg, type, ...])
ListOfShapesModel(*[, shapes])
NStateModel(*[, name, state, msg, type, ...])
SampleChangerCommandInputModel(*, cmd, arguments)
SampleInputModel(*, location[, sampleName, ...])
StrValueModel(*[, value])

class mxcubeweb.core.models.adaptermodels.Base64StrModel(*, value: str = '')

Bases: BaseModel

Parameters:

value (str) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'value': FieldInfo(annotation=str, required=False, default='', description='Base64 encoded string')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.BeamlineActionInputModel(*, cmd: str, parameters: dict | list)

Bases: BaseModel

Parameters:

• cmd (str) –

• parameters (dict | list) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'cmd': FieldInfo(annotation=str, required=True), 'parameters': FieldInfo(annotation=Union[dict, list], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.FloatValueModel(*, value: float = 0)

Bases: BaseModel

Parameters:

value (float) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'value': FieldInfo(annotation=float, required=False, default=0, description='Value of actuator (position)')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.FrontEndStackTraceModel(*, stack: str, state: dict)

Bases: BaseModel

Parameters:

• stack (str) –

• state (dict) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'stack': FieldInfo(annotation=str, required=True), 'state': FieldInfo(annotation=dict, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.HOActuatorModel(*, name: str = '', state: str = '', msg: str = '', type: str = '', available: bool = True, readonly: bool = True, attributes: dict = {}, commands: dict | list = {}, value: float = 0, limits: tuple[float | None, float | None] = (-1, -1))

Bases: HOModel

Parameters:

• name (str) –

• state (str) –

• msg (str) –

• type (str) –

• available (bool) –

• readonly (bool) –

• attributes (dict) –

• commands (dict | list) –

• value (float) –

• limits (tuple[float | None, float | None]) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'attributes': FieldInfo(annotation=dict, required=False, default={}, description='Data attributes'), 'available': FieldInfo(annotation=bool, required=False, default=True, description='True if the object avilable/enabled'), 'commands': FieldInfo(annotation=Union[dict, list], required=False, default={}, description='Available methods'), 'limits': FieldInfo(annotation=tuple[Union[float, NoneType], Union[float, NoneType]], required=False, default=(-1, -1), description='Limits (min max)'), 'msg': FieldInfo(annotation=str, required=False, default='', description='additional message to display'), 'name': FieldInfo(annotation=str, required=False, default='', description='name of the hardware object'), 'readonly': FieldInfo(annotation=bool, required=False, default=True, description='True if the object can only be read (not manipluated)'), 'state': FieldInfo(annotation=str, required=False, default='', description='hardware object state'), 'type': FieldInfo(annotation=str, required=False, default='', description='type of data the object contains'), 'value': FieldInfo(annotation=float, required=False, default=0, description='Value of actuator (position)')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.HOActuatorValueChangeModel(*, name: str = '', value: float | str = '')

Bases: BaseModel

Parameters:

• name (str) –

• value (float | str) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'name': FieldInfo(annotation=str, required=False, default='', description='Name of the hardware object to change'), 'value': FieldInfo(annotation=Union[float, str], required=False, default='', description='New value of actuator (position)')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.HOBeamModel(*, name: str = '', state: str = '', msg: str = '', type: str = '', available: bool = True, readonly: bool = True, attributes: dict = {}, commands: dict | list = {}, value: HOBeamValueModel, limits: tuple[float | None, float | None] = (-1, -1))

Bases: HOActuatorModel

Parameters:

• name (str) –

• state (str) –

• msg (str) –

• type (str) –

• available (bool) –

• readonly (bool) –

• attributes (dict) –

• commands (dict | list) –

• value (HOBeamValueModel) –

• limits (tuple[float | None, float | None]) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'attributes': FieldInfo(annotation=dict, required=False, default={}, description='Data attributes'), 'available': FieldInfo(annotation=bool, required=False, default=True, description='True if the object avilable/enabled'), 'commands': FieldInfo(annotation=Union[dict, list], required=False, default={}, description='Available methods'), 'limits': FieldInfo(annotation=tuple[Union[float, NoneType], Union[float, NoneType]], required=False, default=(-1, -1), description='Limits (min max)'), 'msg': FieldInfo(annotation=str, required=False, default='', description='additional message to display'), 'name': FieldInfo(annotation=str, required=False, default='', description='name of the hardware object'), 'readonly': FieldInfo(annotation=bool, required=False, default=True, description='True if the object can only be read (not manipluated)'), 'state': FieldInfo(annotation=str, required=False, default='', description='hardware object state'), 'type': FieldInfo(annotation=str, required=False, default='', description='type of data the object contains'), 'value': FieldInfo(annotation=HOBeamValueModel, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.HOBeamValueModel(*, apertureList: list[str] = [0], currentAperture: str = 0, position: tuple[float, float] = (0, 0), shape: str = 'ellipse', size_x: float = 0.01, size_y: float = 0.01)

Bases: BaseModel

Parameters:

• apertureList (list[str]) –

• currentAperture (str) –

• position (tuple[float, float]) –

• shape (str) –

• size_x (float) –

• size_y (float) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'apertureList': FieldInfo(annotation=list[str], required=False, default=[0], description='List of available apertures'), 'currentAperture': FieldInfo(annotation=str, required=False, default=0, description='Current aperture label'), 'position': FieldInfo(annotation=tuple[float, float], required=False, default=(0, 0), description='Beam position on OAV'), 'shape': FieldInfo(annotation=str, required=False, default='ellipse', json_schema_extra={'descrption': 'Beam shape'}), 'size_x': FieldInfo(annotation=float, required=False, default=0.01, description='Current beam x size (width) in millimieters'), 'size_y': FieldInfo(annotation=float, required=False, default=0.01, description='Current beam y size (height) in millimieters')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.HOMachineInfoModel(*, name: str = '', state: str = '', msg: str = '', type: str = '', available: bool = True, readonly: bool = True, attributes: dict = {}, commands: dict | list = {}, limits: tuple[float | None, float | None] = (-1, -1), value: dict)

Bases: HOModel

Parameters:

• name (str) –

• state (str) –

• msg (str) –

• type (str) –

• available (bool) –

• readonly (bool) –

• attributes (dict) –

• commands (dict | list) –

• limits (tuple[float | None, float | None]) –

• value (dict) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'attributes': FieldInfo(annotation=dict, required=False, default={}, description='Data attributes'), 'available': FieldInfo(annotation=bool, required=False, default=True, description='True if the object avilable/enabled'), 'commands': FieldInfo(annotation=Union[dict, list], required=False, default={}, description='Available methods'), 'limits': FieldInfo(annotation=tuple[Union[float, NoneType], Union[float, NoneType]], required=False, default=(-1, -1), description='Limits (min max)'), 'msg': FieldInfo(annotation=str, required=False, default='', description='additional message to display'), 'name': FieldInfo(annotation=str, required=False, default='', description='name of the hardware object'), 'readonly': FieldInfo(annotation=bool, required=False, default=True, description='True if the object can only be read (not manipluated)'), 'state': FieldInfo(annotation=str, required=False, default='', description='hardware object state'), 'type': FieldInfo(annotation=str, required=False, default='', description='type of data the object contains'), 'value': FieldInfo(annotation=dict, required=True, description='Value of machine info')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.HOModel(*, name: str = '', state: str = '', msg: str = '', type: str = '', available: bool = True, readonly: bool = True, attributes: dict = {}, commands: dict | list = {})

Bases: BaseModel

Parameters:

• name (str) –

• state (str) –

• msg (str) –

• type (str) –

• available (bool) –

• readonly (bool) –

• attributes (dict) –

• commands (dict | list) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'attributes': FieldInfo(annotation=dict, required=False, default={}, description='Data attributes'), 'available': FieldInfo(annotation=bool, required=False, default=True, description='True if the object avilable/enabled'), 'commands': FieldInfo(annotation=Union[dict, list], required=False, default={}, description='Available methods'), 'msg': FieldInfo(annotation=str, required=False, default='', description='additional message to display'), 'name': FieldInfo(annotation=str, required=False, default='', description='name of the hardware object'), 'readonly': FieldInfo(annotation=bool, required=False, default=True, description='True if the object can only be read (not manipluated)'), 'state': FieldInfo(annotation=str, required=False, default='', description='hardware object state'), 'type': FieldInfo(annotation=str, required=False, default='', description='type of data the object contains')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.ListOfShapesModel(*, shapes: list[dict] = [])

Bases: BaseModel

Parameters:

shapes (list[dict]) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'shapes': FieldInfo(annotation=list[dict], required=False, default=[], description='List of dictionaries')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.NStateModel(*, name: str = '', state: str = '', msg: str = '', type: str = '', available: bool = True, readonly: bool = True, attributes: dict = {}, commands: dict | list = {}, value: str = '', limits: tuple[float | None, float | None] = (-1, -1))

Bases: HOActuatorModel

Parameters:

• name (str) –

• state (str) –

• msg (str) –

• type (str) –

• available (bool) –

• readonly (bool) –

• attributes (dict) –

• commands (dict | list) –

• value (str) –

• limits (tuple[float | None, float | None]) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'attributes': FieldInfo(annotation=dict, required=False, default={}, description='Data attributes'), 'available': FieldInfo(annotation=bool, required=False, default=True, description='True if the object avilable/enabled'), 'commands': FieldInfo(annotation=Union[dict, list], required=False, default={}, description='Available methods'), 'limits': FieldInfo(annotation=tuple[Union[float, NoneType], Union[float, NoneType]], required=False, default=(-1, -1), description='Limits (min max)'), 'msg': FieldInfo(annotation=str, required=False, default='', description='additional message to display'), 'name': FieldInfo(annotation=str, required=False, default='', description='name of the hardware object'), 'readonly': FieldInfo(annotation=bool, required=False, default=True, description='True if the object can only be read (not manipluated)'), 'state': FieldInfo(annotation=str, required=False, default='', description='hardware object state'), 'type': FieldInfo(annotation=str, required=False, default='', description='type of data the object contains'), 'value': FieldInfo(annotation=str, required=False, default='', description='Value of nstate object')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.SampleChangerCommandInputModel(*, cmd: str, arguments: str | None)

Bases: BaseModel

Parameters:

• cmd (str) –

• arguments (str | None) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'arguments': FieldInfo(annotation=Union[str, NoneType], required=True), 'cmd': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.SampleInputModel(*, location: str, sampleName: str = '', sampleID: str = '')

Bases: BaseModel

Parameters:

• location (str) –

• sampleName (str) –

• sampleID (str) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'populate_by_name': True}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'location': FieldInfo(annotation=str, required=True), 'sample_id': FieldInfo(annotation=str, required=False, default='', alias='sampleID', alias_priority=2), 'sample_name': FieldInfo(annotation=str, required=False, default='', alias='sampleName', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubeweb.core.models.adaptermodels.StrValueModel(*, value: str = '')

Bases: BaseModel

Parameters:

value (str) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[dict[str, FieldInfo]] = {'value': FieldInfo(annotation=str, required=False, default='', description='Value of actuator (position)')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.