mxcubeweb.core.adapter.beamline_action_adapter

Classes

Action(*, name, username, state, arguments, ...)
ActionsList(*, actions_list)
Argument(*, name, type[, items])
BeamlineActionAdapter(ho, role, app[, ...])
JSONSchemaArgument(*, name, type[, jsonschema])

class mxcubeweb.core.adapter.beamline_action_adapter.BeamlineActionAdapter(ho: HardwareObject, role: str, app, resource_handler_config: ResourceHandlerConfigModel = ResourceHandlerConfigModel(url_prefix='', exports=[], commands=['stop', 'run_action'], attributes=['data', 'get_all_actions']))

Bases: AdapterBase

Parameters:

• ho (HardwareObject) –

• role (str) –

• resource_handler_config (ResourceHandlerConfigModel) –

msg()

Returns a message describing the current state. should be used to communicate details of the state to the user. :returns: The message string. :rtype: (str)

run_action(value: BeamlineActionInputModel)

Starts beamline action

Parameters:

value (BeamlineActionInputModel) –

stop()

Stop the execution.