Taurus Extensions

Functions

Classes

registerExtensions()[source]

Registers the macroserver extensions in the taurus.core.tango.TangoFactory

unregisterExtensions()[source]

Registers the macroserver extensions in the taurus.core.tango.TangoFactory

BaseDoor

Inheritance diagram of BaseDoor
class BaseDoor(name, **kw)[source]

Bases: MacroServerDevice

Class encapsulating Door device functionality.

On = tango._tango.DevState.ON
Alarm = tango._tango.DevState.ALARM
Running = tango._tango.DevState.RUNNING
Paused = tango._tango.DevState.STANDBY
Critical = 'Critical'

Critical message level (constant)

Error = 'Error'

Error message level (constant)

Warning = 'Warning'

Warning message level (constant)

Info = 'Info'

Info message level (constant)

Output = 'Output'
Debug = 'Debug'

Debug message level (constant)

Result = 'Result'
RecordData = 'RecordData'
BlockStart = '<BLOCK>'
BlockFinish = '</BLOCK>'
log_streams = ('Error', 'Warning', 'Info', 'Output', 'Debug', 'Result')
InteractiveTimeout = 0.3
create_input_handler()[source]
get_input_handler()[source]
get_color_mode()[source]
property log_start
property log_stop
getStateAttr()[source]
property macro_server
setDebugMode(state)[source]
getDebugMode()[source]
setSilent(yesno)[source]
isSilent()[source]
getLogObj(log_name='Debug')[source]

Returns the log object for this object

Returns:

the log object

Return type:

logging.Logger

getRunningXML()[source]
getRunningMacro()[source]
getLastRunningMacro()[source]
abort(synch=True, timeout=None)[source]

Executes the “Abort” command on the Door

Parameters:

  • synch (bool) – If True, waits the Abort process to finish.

  • timeout (Optional[float]) – Wait timeout (in seconds). Only used if synch=True.

release(synch=True)[source]
stop(synch=True, timeout=None)[source]

Executes the “Stop” command on the Door

Parameters:

  • synch (bool) – If True, waits the Stop process to finish.

  • timeout (Optional[float]) – Wait timeout (in seconds). Only used if synch=True.

preRunMacro(obj, parameters)[source]
postRunMacro(result, synch)[source]
runMacro(obj, parameters=[], synch=False)[source]
stateChanged(s, t, v)[source]
resultReceived(log_name, result)[source]

Method invoked by the arrival of a change event on the Result attribute

putEnvironment(name, value)[source]
putEnvironments(obj)[source]
setEnvironment(name, value)
setEnvironments(obj)
getEnvironment(name=None)[source]
inputReceived(s, t, v)[source]
processInput(input_data)[source]
recordDataReceived(s, t, v)[source]
processRecordData(data)[source]
macroStatusReceived(s, t, v)[source]
logReceived(log_name, output)[source]
write(msg, stream=None)[source]
writeln(msg='', stream=None)[source]
getReservedElements()[source]

Return reserved elements of macros currently being executed

Return type:

List[Dict]

Returns:

Stack of infos about reserved elements implemented as a list of dictionaries. Each dictionary corresponds to one macro. The order of the list corresponds to the order of macros being called - the last item corresponds to the macro on top of the stack.

Dictionary with info contains at least the following key - value pairs:

  • elements - list of reserved element names (strings)

getExperimentConfigurationObj()[source]
getExperimentConfiguration()[source]
setExperimentConfiguration(config, mnt_grps=None)[source]

BaseMacroServer

Inheritance diagram of BaseMacroServer
class BaseMacroServer(name, **kw)[source]

Bases: MacroServerDevice

Class encapsulating Macro Server device functionality.

NO_CLASS_TYPES = ('ControllerClass', 'ControllerLibrary', 'MacroLibrary', 'Instrument', 'Meta', 'ParameterType')
on_environment_changed(evt_src, evt_type, evt_value)[source]
putEnvironment(name, value)[source]
putEnvironments(obj)[source]
setEnvironment(name, value)
setEnvironments(obj)
getEnvironment(name=None)[source]
removeEnvironment(key)[source]
removeEnvironments(keys)[source]
getObject(element_info)[source]
on_elements_changed(evt_src, evt_type, evt_value)[source]
getElementsInfo()[source]
getElements()[source]
getElementInfo(name)[source]
getElementNamesOfType(elem_type)[source]
getElementNamesWithInterface(interface)[source]
getElementsWithInterface(interface)[source]
getElementsWithInterfaces(interfaces)[source]
getElementsOfType(elem_type)[source]
getElementsOfTypes(elem_types)[source]
getInterfaces()[source]
getExpChannelElements()[source]
getMacros()[source]
getMacroInfoObj(macro_name)[source]
getMacroStrList()[source]
getMacroNodeObj(macro_name)[source]

This method retrieves information about macro from MacroServer and creates MacroNode object, filled with all information about parameters.

Parameters:

macro_name – (str) macro name

Returns:

(MacroNode)

See Also: fillMacroNodeAddidtionalInfos

validateMacroName(macroName)[source]
validateMacroNode(macroNode)[source]
validateParamNode(paramNode)[source]
validateSingleParam(singleParamNode)[source]
validateRepeatParam(repeatParamNode)[source]
fillMacroNodeAdditionalInfos(macroNode)[source]

This method fills macroNode information which couldn’t be stored in XML file.

Parameters:

macroNode – (MacroNode) macro node obj populated from XML information

See also: getMacroNodeObj

printTree(nodes, tabs=0)[source]
getMacroPathObj(cache=False)[source]