mxcubecore.HardwareObjects.BeamlineActions#

Classes

AnnotatedCommand(beamline_action_ho, name, ...)

BeamlineActions(name)

ControllerCommand(name[, cmd, username, klass])

HWObjActuatorCommand(name, hwobj)

Class for two state hardware objects
class mxcubecore.HardwareObjects.BeamlineActions.AnnotatedCommand(beamline_action_ho, name, cmd_name)[source]#

Bases: CommandObject

class mxcubecore.HardwareObjects.BeamlineActions.BeamlineActions(name)[source]#

Bases: HardwareObject

execute_command(name, args)[source]#

Execute command.

Parameters:

  • command_name (str) – Command name.

  • *args (tuple) – Arguments to pass through to the command to be executed.

  • **kwargs (Dict[str, Any]) – Named arguments to pass through to the

  • executed. (command to be) –

Raises:

AttributeError – If command not found.

Returns:

Execution output.

Return type:

Any

get_commands()[source]#

Get object commands.

Yields:

Generator[CommandObject, None, None] – Command objects.

init()[source]#

‘public’ post-initialization method. Override as needed.

For ConfiguredObjects called after loading contained objects.

class mxcubecore.HardwareObjects.BeamlineActions.ControllerCommand(name, cmd=None, username=None, klass=None)[source]#

Bases: CommandObject

abort()[source]#

Abort the execution.

is_connected()[source]#

Check if signal is connected.

Returns:

True if connected, else False.

Return type:

bool

class mxcubecore.HardwareObjects.BeamlineActions.HWObjActuatorCommand(name, hwobj)[source]#

Bases: CommandObject

Class for two state hardware objects

value()[source]#

Return the current command value. :returns: The value as a string :rtype: (str)