mxcubecore.queue_entry.test_collection

Classes

TestCollectionQueueEntry(view, data_model)	Defines the behaviour of a data collection.
TestCollectionQueueModel(**kwargs)
TestCollectionTaskParameters(*, ...)
TestUserCollectionParameters(*[, ...])

class mxcubecore.queue_entry.test_collection.TestCollectionQueueEntry(view, data_model: TestCollectionQueueModel)

Bases: BaseQueueEntry

Defines the behaviour of a data collection.

Parameters:

data_model (TestCollectionQueueModel) –

DATA_MODEL

alias of TestCollectionTaskParameters

QMO

alias of TestCollectionQueueModel

execute()

Execute method, should be overridden my subclasses, defines the main body of the procedure to be performed when the entry is executed.

The default executer calls execute on all child entries after this method but before post_execute.

post_execute()

Procedure to be done after execute, and execute of all children of this entry.

pre_execute()

Procedure to be done before execute.

class mxcubecore.queue_entry.test_collection.TestCollectionQueueModel(**kwargs)

Bases: DataCollection

class mxcubecore.queue_entry.test_collection.TestCollectionTaskParameters(*, path_parameters: PathParameters, common_parameters: CommonCollectionParamters, collection_parameters: StandardCollectionParameters, user_collection_parameters: TestUserCollectionParameters, legacy_parameters: LegacyParameters)

Bases: BaseModel

Parameters:

• path_parameters (PathParameters) –

• common_parameters (CommonCollectionParamters) –

• collection_parameters (StandardCollectionParameters) –

• user_collection_parameters (TestUserCollectionParameters) –

• legacy_parameters (LegacyParameters) –

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]] = {'collection_parameters': FieldInfo(annotation=StandardCollectionParameters, required=True), 'common_parameters': FieldInfo(annotation=CommonCollectionParamters, required=True), 'legacy_parameters': FieldInfo(annotation=LegacyParameters, required=True), 'path_parameters': FieldInfo(annotation=PathParameters, required=True), 'user_collection_parameters': FieldInfo(annotation=TestUserCollectionParameters, 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 mxcubecore.queue_entry.test_collection.TestUserCollectionParameters(*, num_images: int = 0, exp_time: float = 0.0001, cell_a: float = 0.0, cell_b: float = 0.0, cell_c: float = 0.0, cell_alpha: float = 0.0, cell_beta: float = 0.0, cell_gamma: float = 0.0)

Bases: BaseModel

Parameters:

• num_images (int) –

• exp_time (float) –

• cell_a (float) –

• cell_b (float) –

• cell_c (float) –

• cell_alpha (float) –

• cell_beta (float) –

• cell_gamma (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]] = {'cell_a': FieldInfo(annotation=float, required=False, default=0.0, title='Cell A'), 'cell_alpha': FieldInfo(annotation=float, required=False, default=0.0, title='Cell Alpha'), 'cell_b': FieldInfo(annotation=float, required=False, default=0.0, title='Cell B'), 'cell_beta': FieldInfo(annotation=float, required=False, default=0.0, title='Cell Beta'), 'cell_c': FieldInfo(annotation=float, required=False, default=0.0, title='Cell C'), 'cell_gamma': FieldInfo(annotation=float, required=False, default=0.0, title='Cell Gamma'), 'exp_time': FieldInfo(annotation=float, required=False, default=0.0001, description='s', metadata=[Gt(gt=0), Lt(lt=1)]), 'num_images': FieldInfo(annotation=int, required=False, default=0, description='')}

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

This replaces Model.__fields__ from Pydantic V1.