mxcubecore.Command.Exporter#

Exporter, ExporterChannel and ExporterCommand implementation

Functions

start_exporter(address, port[, timeout, retries])

Start the exporter

Classes

`Exporter`(address, port[, timeout, retries])	Exporter class
`ExporterChannel`(name, attribute_name[, ...])	Channel implementation for Exporter
`ExporterCommand`(name, command[, username, ...])	Command implementation for Exporter

class mxcubecore.Command.Exporter.Exporter(address, port, timeout=3, retries=1)[source]#

Bases: ExporterClient, object

Exporter class

execute(*args, **kwargs)[source]#: Execute

get_state()[source]#: Read the state

on_disconnected()[source]#: Actions on disconnect

on_event(name, value, timestamp)[source]#: Put the event in the queue :param name: Name :param value: Value :param timestamp: Timestamp

process_events_from_queue()[source]#: Process events from the queue

read_property(*args, **kwargs)[source]#: Read a property

reconnect()[source]#: Reconnect

register(name, cb)[source]#: Register to a callback

start()[source]#: Start

stop()[source]#: Stop

class mxcubecore.Command.Exporter.ExporterChannel(name, attribute_name, username=None, address=None, port=None, timeout=3, **kwargs)[source]#

Bases: ChannelObject

Channel implementation for Exporter

get_value()[source]#: Get the value :returns: The value :rtype: (str)

is_connected()[source]#: Check if connected. :returns: True if connected. :rtype: (bool)

set_value(value)[source]#: Set a value :param value: Value to set :type value: str

update(value=None)[source]#: Emit signal update when value changed

class mxcubecore.Command.Exporter.ExporterCommand(name, command, username=None, address=None, port=None, timeout=3, **kwargs)[source]#

Bases: CommandObject

Command implementation for Exporter

abort()[source]#: Abort

get_state()[source]#: FRead the state :returns: State :rtype: (str)

is_connected()[source]#: Check if connected. :returns: True if connected :rtype: (bool)

mxcubecore.Command.Exporter.start_exporter(address, port, timeout=3, retries=1)[source]#: Start the exporter