sardanadefs
¶
This module contains the most generic sardana constants and enumerations
Constants
-
EpsilonError
= 1e-16¶ maximum difference between two floats so that they are considered equal
-
InvalidId
= 0¶ A constant representing an invalid ID
-
InvalidAxis
= 0¶ A constant representing an invalid axis
-
TYPE_ELEMENTS
= set([2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12])¶ a set containning all “controllable” element types. Constant values belong to
ElementType
-
TYPE_GROUP_ELEMENTS
= set([13, 14])¶ a set containing all group element types. Constant values belong to
ElementType
-
TYPE_MOVEABLE_ELEMENTS
= set([2, 10, 13])¶ a set containing the type of elements which are moveable. Constant values belong to
ElementType
-
TYPE_PHYSICAL_ELEMENTS
= set([2, 3, 4, 5, 6, 7, 8, 9])¶ a set containing the possible types of physical elements. Constant values belong to
ElementType
-
TYPE_ACQUIRABLE_ELEMENTS
= set([2, 3, 4, 5, 6, 7, 8, 10, 11])¶ a set containing the possible types of acquirable elements. Constant values belong to
ElementType
-
TYPE_PSEUDO_ELEMENTS
= set([10, 11])¶ a set containing the possible types of pseudo elements. Constant values belong to
ElementType
-
SardanaServer
= SardanaServer()¶ the global object containing the SardanaServer information
Enumerations
-
ServerRunMode
= Enumeration('ServerRunMode', ['SynchPure', 'SynchThread', 'SynchProcess', 'AsynchThread', 'AsynchProcess'])¶ The sardana server run mode:
- SynchPure : Pure synchronous: Start the server and run the server loop until it stops
- SynchThread : separate thread synchronous: start a thread running the server loop. Block until the server loop ends
- SynchProcess : separate process synchronous: start a sub-process running the server loop. Block until the server loop ends
- AsynchThread : separate thread asynchronous: start a thread running the server loop. Return immediately
- ASynchProcess : separate process asynchronous: start a sub-process running the server loop. Return immediately
-
State
= Enumeration('State', ['On', 'Off', 'Close', 'Open', 'Insert', 'Extract', 'Moving', 'Standby', 'Fault', 'Init', 'Running', 'Alarm', 'Disable', 'Unknown', 'Invalid'])¶ sardana element state enumeration
-
DataType
= Enumeration('DataType', ['Integer', 'Double', 'String', 'Boolean', 'Encoded', 'Invalid'])¶ sardana data types (used by device pool controllers)
-
DataFormat
= Enumeration('DataFormat', ['Scalar', 'OneD', 'TwoD', 'Invalid'])¶ sardana data format enumeration (used by device pool controllers)
-
DataAccess
= Enumeration('DataAccess', ['ReadOnly', 'ReadWrite', 'Invalid'])¶ sardana data access (used by device pool controllers)
-
ElementType
= Enumeration('ElementType', ['Pool', 'Controller', 'Motor', 'CTExpChannel', 'ZeroDExpChannel', 'OneDExpChannel', 'TwoDExpChannel', 'ComChannel', 'IORegister', 'TriggerGate', 'PseudoMotor', 'PseudoCounter', 'Constraint', 'MotorGroup', 'MeasurementGroup', 'Instrument', 'ControllerClass', 'ControllerLibrary', 'RecorderClass', 'RecorderLibrary', 'MacroServer', 'Door', 'MacroClass', 'MacroLibrary', 'MacroFunction', 'External', 'Meta', 'ParameterType', 'Unknown'])¶ An enumeration describing the all possible element types in sardana
-
Interface
= Enumeration('Interface', ['Object', 'PoolObject', 'Element', 'PoolElement', 'Acquirable', 'IORegister', 'Instrument', 'MacroServerObject', 'MacroCode', 'Class', 'MacroClass', 'Function', 'MacroServerElement', 'Door', 'Controller', 'External', 'MacroServer', 'Library', 'MacroLibrary', 'MacroFunction', 'ComChannel', 'ExpChannel', 'ZeroDExpChannel', 'Constraint', 'Macro', 'TwoDExpChannel', 'Moveable', 'OneDExpChannel', 'PseudoCounter', 'MeasurementGroup', 'PseudoMotor', 'Meta', 'ParameterType', 'TriggerGate', 'MotorGroup', 'ControllerLibrary', 'Pool', 'Motor', 'CTExpChannel', 'ControllerClass'])¶ An enumeration describing the all possible sardana interfaces
-
Interfaces
= {1L: set([]), 3L: set([1L]), 5L: set([1L]), 15L: set([3L, 5L]), 31L: set([15L]), 63L: set([31L]), 79L: set([15L]), 129L: set([1L]), 385L: set([129L]), 513L: set([1L]), 1921L: set([385L, 513L]), 2049L: set([1L]), 4229L: set([5L, 129L]), 12421L: set([4229L]), 16399L: set([15L]), 32769L: set([1L]), 69765L: set([4229L]), 131073L: set([1L]), 393345L: set([129L, 131073L]), 526721L: set([385L, 2049L]), 1048591L: set([15L]), 2097183L: set([31L]), 6291487L: set([2097183L]), 8388611L: set([3L]), 17305473L: set([1921L, 526721L]), 35651615L: set([2097183L]), 67108879L: set([15L]), 136314911L: set([2097183L]), 270532639L: set([2097183L]), 536870927L: set([15L]), 1140850719L: set([31L, 67108879L]), 2147483648L: set([]), 6442450944L: set([2147483648L]), 8589934607L: set([15L]), 17179869199L: set([15L]), 34359869443L: set([3L, 131073L]), 68719476751L: set([15L]), 137506062367L: set([31L, 67108879L]), 274880004127L: set([2097183L]), 549755814403L: set([3L, 513L])}¶ a dictionary containing the direct interfaces supported by each type (
dict
<sardana.sardanadefs.Interface
,set
<sardana.sardanadefs.Interface
> >)
-
InterfacesExpanded
= {1L: set([1L]), 3L: set([1L, 3L]), 5L: set([1L, 5L]), 15L: set([1L, 3L, 5L, 15L]), 31L: set([1L, 3L, 5L, 15L, 31L]), 63L: set([1L, 3L, 5L, 15L, 31L, 63L]), 79L: set([1L, 3L, 5L, 15L, 79L]), 129L: set([1L, 129L]), 385L: set([1L, 129L, 385L]), 513L: set([1L, 513L]), 1921L: set([1L, 129L, 385L, 513L, 1921L]), 2049L: set([1L, 2049L]), 4229L: set([1L, 5L, 129L, 4229L]), 12421L: set([1L, 5L, 129L, 4229L, 12421L]), 16399L: set([1L, 3L, 5L, 15L, 16399L]), 32769L: set([1L, 32769L]), 69765L: set([1L, 5L, 129L, 4229L, 69765L]), 131073L: set([1L, 131073L]), 393345L: set([1L, 129L, 131073L, 393345L]), 526721L: set([1L, 129L, 385L, 2049L, 526721L]), 1048591L: set([1L, 3L, 5L, 15L, 1048591L]), 2097183L: set([1L, 3L, 5L, 15L, 31L, 2097183L]), 6291487L: set([1L, 3L, 5L, 15L, 31L, 2097183L, 6291487L]), 8388611L: set([1L, 3L, 8388611L]), 17305473L: set([1L, 129L, 385L, 513L, 1921L, 2049L, 526721L, 17305473L]), 35651615L: set([1L, 3L, 5L, 15L, 31L, 2097183L, 35651615L]), 67108879L: set([1L, 3L, 5L, 15L, 67108879L]), 136314911L: set([1L, 3L, 5L, 15L, 31L, 2097183L, 136314911L]), 270532639L: set([1L, 3L, 5L, 15L, 31L, 2097183L, 270532639L]), 536870927L: set([1L, 3L, 5L, 15L, 536870927L]), 1140850719L: set([1L, 3L, 5L, 15L, 31L, 67108879L, 1140850719L]), 2147483648L: set([2147483648L]), 6442450944L: set([2147483648L, 6442450944L]), 8589934607L: set([1L, 3L, 5L, 15L, 8589934607L]), 17179869199L: set([1L, 3L, 5L, 15L, 17179869199L]), 34359869443L: set([1L, 3L, 131073L, 34359869443L]), 68719476751L: set([1L, 3L, 5L, 15L, 68719476751L]), 137506062367L: set([1L, 3L, 5L, 15L, 31L, 67108879L, 137506062367L]), 274880004127L: set([1L, 3L, 5L, 15L, 31L, 2097183L, 274880004127L]), 549755814403L: set([1L, 3L, 513L, 549755814403L])}¶ a dictionary containing the all interfaces supported by each type. (
dict
<sardana.sardanadefs.Interface
,set
<sardana.sardanadefs.Interface
> >)
-
INTERFACES
= {'Acquirable': (set(['PoolElement']), 'An acquirable element'), 'CTExpChannel': (set(['ExpChannel']), 'A counter/timer experimental channel'), 'Class': (set(['Object']), 'A generic sardana class'), 'ComChannel': (set(['PoolElement']), 'A communication channel'), 'Constraint': (set(['PoolObject']), 'A constraint'), 'Controller': (set(['PoolElement']), 'A controller'), 'ControllerClass': (set(['Class', 'PoolObject']), 'A controller class'), 'ControllerLibrary': (set(['PoolObject', 'Library']), 'A controller library'), 'Door': (set(['MacroServerElement']), 'A macro server door'), 'Element': (set(['Object']), 'A generic sardana element'), 'ExpChannel': (set(['Acquirable']), 'A generic experimental channel'), 'External': (set(['Object']), 'An external object'), 'Function': (set(['Object']), 'A generic sardana function'), 'IORegister': (set(['Acquirable']), 'An IO register'), 'Instrument': (set(['PoolElement']), 'An instrument'), 'Library': (set(['Object']), 'A generic sardana library'), 'Macro': (set(['MacroFunction', 'MacroClass']), 'A macro server macro'), 'MacroClass': (set(['MacroCode', 'Class']), 'A macro server macro class'), 'MacroCode': (set(['MacroServerObject']), 'A macro server macro code'), 'MacroFunction': (set(['Function', 'MacroCode']), 'A macro server macro function'), 'MacroLibrary': (set(['MacroServerObject', 'Library']), 'A macro server library'), 'MacroServer': (set(['MacroServerElement']), 'A MacroServer'), 'MacroServerElement': (set(['MacroServerObject', 'Element']), 'A generic macro server element'), 'MacroServerObject': (set(['Object']), 'A generic macro server object'), 'MeasurementGroup': (set(['PoolElement']), 'A measurement group'), 'Meta': (set([]), 'A generic sardana meta object'), 'Motor': (set(['Acquirable', 'Moveable']), 'a motor'), 'MotorGroup': (set(['PoolElement']), 'A motor group'), 'Moveable': (set(['PoolElement']), 'A moveable element'), 'Object': (set([]), 'A generic sardana object'), 'OneDExpChannel': (set(['ExpChannel']), 'A 1D experimental channel'), 'ParameterType': (set(['Meta']), 'A generic macro server parameter type'), 'Pool': (set(['PoolElement']), 'A Pool'), 'PoolElement': (set(['PoolObject', 'Element']), 'A Pool element'), 'PoolObject': (set(['Object']), 'A Pool object'), 'PseudoCounter': (set(['ExpChannel']), 'A pseudo counter'), 'PseudoMotor': (set(['Acquirable', 'Moveable']), 'A pseudo motor'), 'TriggerGate': (set(['PoolElement']), 'A trigger/gate'), 'TwoDExpChannel': (set(['ExpChannel']), 'A 2D experimental channel'), 'ZeroDExpChannel': (set(['ExpChannel']), 'A 0D experimental channel')}¶ a dictionary containing the direct interfaces supported by each type (
dict
<str
,tuple
<set
<str
,str
>>>)
-
INTERFACES_EXPANDED
= {'Acquirable': (set(['PoolElement', 'Object', 'Acquirable', 'PoolObject', 'Element']), 'An acquirable element'), 'CTExpChannel': (set(['ExpChannel', 'PoolObject', 'CTExpChannel', 'Acquirable', 'PoolElement', 'Object', 'Element']), 'A counter/timer experimental channel'), 'Class': (set(['Object', 'Class']), 'A generic sardana class'), 'ComChannel': (set(['PoolElement', 'Object', 'PoolObject', 'ComChannel', 'Element']), 'A communication channel'), 'Constraint': (set(['Object', 'PoolObject', 'Constraint']), 'A constraint'), 'Controller': (set(['PoolElement', 'Controller', 'Object', 'PoolObject', 'Element']), 'A controller'), 'ControllerClass': (set(['ControllerClass', 'Object', 'Class', 'PoolObject']), 'A controller class'), 'ControllerLibrary': (set(['ControllerLibrary', 'Object', 'PoolObject', 'Library']), 'A controller library'), 'Door': (set(['MacroServerElement', 'Object', 'Door', 'MacroServerObject', 'Element']), 'A macro server door'), 'Element': (set(['Object', 'Element']), 'A generic sardana element'), 'ExpChannel': (set(['ExpChannel', 'PoolObject', 'PoolElement', 'Acquirable', 'Object', 'Element']), 'A generic experimental channel'), 'External': (set(['Object', 'External']), 'An external object'), 'Function': (set(['Function', 'Object']), 'A generic sardana function'), 'IORegister': (set(['PoolObject', 'PoolElement', 'Acquirable', 'Object', 'IORegister', 'Element']), 'An IO register'), 'Instrument': (set(['Instrument', 'PoolElement', 'Object', 'PoolObject', 'Element']), 'An instrument'), 'Library': (set(['Object', 'Library']), 'A generic sardana library'), 'Macro': (set(['Function', 'Macro', 'Object', 'Class', 'MacroCode', 'MacroFunction', 'MacroServerObject', 'MacroClass']), 'A macro server macro'), 'MacroClass': (set(['MacroCode', 'Object', 'Class', 'MacroClass', 'MacroServerObject']), 'A macro server macro class'), 'MacroCode': (set(['MacroCode', 'Object', 'MacroServerObject']), 'A macro server macro code'), 'MacroFunction': (set(['Function', 'MacroCode', 'MacroFunction', 'Object', 'MacroServerObject']), 'A macro server macro function'), 'MacroLibrary': (set(['MacroLibrary', 'Object', 'MacroServerObject', 'Library']), 'A macro server library'), 'MacroServer': (set(['MacroServerElement', 'Object', 'MacroServerObject', 'MacroServer', 'Element']), 'A MacroServer'), 'MacroServerElement': (set(['MacroServerElement', 'Object', 'MacroServerObject', 'Element']), 'A generic macro server element'), 'MacroServerObject': (set(['Object', 'MacroServerObject']), 'A generic macro server object'), 'MeasurementGroup': (set(['PoolElement', 'Object', 'PoolObject', 'MeasurementGroup', 'Element']), 'A measurement group'), 'Meta': (set(['Meta']), 'A generic sardana meta object'), 'Motor': (set(['Acquirable', 'Object', 'Element', 'PoolObject', 'Motor', 'Moveable', 'PoolElement']), 'a motor'), 'MotorGroup': (set(['PoolElement', 'MotorGroup', 'Object', 'PoolObject', 'Element']), 'A motor group'), 'Moveable': (set(['PoolElement', 'Object', 'Moveable', 'PoolObject', 'Element']), 'A moveable element'), 'Object': (set(['Object']), 'A generic sardana object'), 'OneDExpChannel': (set(['ExpChannel', 'OneDExpChannel', 'PoolObject', 'Acquirable', 'PoolElement', 'Object', 'Element']), 'A 1D experimental channel'), 'ParameterType': (set(['ParameterType', 'Meta']), 'A generic macro server parameter type'), 'Pool': (set(['PoolElement', 'Object', 'PoolObject', 'Pool', 'Element']), 'A Pool'), 'PoolElement': (set(['PoolElement', 'Object', 'PoolObject', 'Element']), 'A Pool element'), 'PoolObject': (set(['Object', 'PoolObject']), 'A Pool object'), 'PseudoCounter': (set(['ExpChannel', 'PoolObject', 'PseudoCounter', 'Acquirable', 'PoolElement', 'Object', 'Element']), 'A pseudo counter'), 'PseudoMotor': (set(['Acquirable', 'Object', 'Element', 'PoolObject', 'Moveable', 'PoolElement', 'PseudoMotor']), 'A pseudo motor'), 'TriggerGate': (set(['PoolElement', 'TriggerGate', 'Object', 'PoolObject', 'Element']), 'A trigger/gate'), 'TwoDExpChannel': (set(['ExpChannel', 'PoolObject', 'Acquirable', 'PoolElement', 'TwoDExpChannel', 'Object', 'Element']), 'A 2D experimental channel'), 'ZeroDExpChannel': (set(['ExpChannel', 'ZeroDExpChannel', 'PoolObject', 'Acquirable', 'PoolElement', 'Object', 'Element']), 'A 0D experimental channel')}¶ a dictionary containing the all interfaces supported by each type (
dict
<str
,set
<str
> >)
Functions
-
from_dtype_str
(dtype)[source]¶ Transforms the given dtype parameter (string/
DataType
or None) into a tuple of two elements (str,DataFormat
) where the first element is a string with a simplified data type.Parameters: dtype ( str
or None orDataType
) – the data type to be transformedReturns: a tuple <str, DataFormat
> for the given dtypeReturn type: tuple<str, DataFormat
>
-
from_access_str
(access)[source]¶ Transforms the given access parameter (string or
DataAccess
) into a simplified data access string.Parameters: dtype ( str
) – the access to be transformedReturns: a simple string for the given access Return type: str
-
to_dtype_dformat
(data)[source]¶ Transforms the given data parameter (string/ or sequence of string or sequence of sequence of string/
DataType
) into a tuple of two elements (DataType
,DataFormat
).Parameters: data ( str
or seq<str> or seq<seq<str>>) – the data information to be transformedReturns: a tuple < DataType
,DataFormat
> for the given dataReturn type: tuple< DataType
,DataFormat
>
-
to_daccess
(daccess)[source]¶ Transforms the given access parameter (string or None) into a
DataAccess
. If None is given returnsDataAccess.ReadWrite
Parameters: dtype ( str
) – the access to be transformedReturns: a DataAccess
for the given accessReturn type: DataAccess