From 0cdefe48d63af0e43e92f6bbf58dfaf1fb952f0f Mon Sep 17 00:00:00 2001 From: Jan Kotanski Date: Wed, 13 Dec 2023 07:18:43 +0100 Subject: [PATCH] add support for user data units and other fields --- ChangeLog | 6 +- man/nxsrecconfig.1 | 572 +++++++++++++++---------------- nxsrecconfig/DynamicComponent.py | 13 +- nxsrecconfig/Release.py | 2 +- 4 files changed, 304 insertions(+), 289 deletions(-) diff --git a/ChangeLog b/ChangeLog index 05db7ef..c806e94 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,4 +1,8 @@ -2023-11-09 Jan Kotanski +2023-11-13 Jan Kotanski + * add support for user data units and other attributes (#120) + * tagged as v3.38.0 + +2023-11-12 Jan Kotanski * add support for dynamic init user data (#116) * tagged as v3.37.0 diff --git a/man/nxsrecconfig.1 b/man/nxsrecconfig.1 index d78f460..d56bbd5 100644 --- a/man/nxsrecconfig.1 +++ b/man/nxsrecconfig.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NXSRECCONFIG" "1" "Dec 12, 2023" "3.37" "NXSRecSelector" +.TH "NXSRECCONFIG" "1" "Dec 13, 2023" "3.38" "NXSRecSelector" .SH NAME nxsrecconfig \- nxsrecconfig Documentation . @@ -339,7 +339,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- checker item name +\fBname\fP (\fI\%str\fP) – checker item name .UNINDENT .INDENT 7.0 .TP @@ -378,9 +378,9 @@ It creates ElementThread from the runnable element .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBindex\fP (\fI\%int\fP) \-\- the current thread index +\fBindex\fP (\fI\%int\fP) – the current thread index .IP \(bu 2 -\fBqueue\fP (\fBQueue.Queue\fP) \-\- queue with tasks +\fBqueue\fP (\fBQueue.Queue\fP) – queue with tasks .UNINDENT .UNINDENT .INDENT 7.0 @@ -436,11 +436,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- datasource name +\fBname\fP (\fI\%str\fP) – datasource name .IP \(bu 2 -\fBdevice\fP (\fI\%str\fP) \-\- datasource device +\fBdevice\fP (\fI\%str\fP) – datasource device .IP \(bu 2 -\fBattr\fP (\fI\%str\fP) \-\- device attribute +\fBattr\fP (\fI\%str\fP) – device attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -473,7 +473,7 @@ contstructor .INDENT 7.0 .TP .B Parameters -\fBver\fP (\fI\%str\fP) \-\- the required selection version +\fBver\fP (\fI\%str\fP) – the required selection version .UNINDENT .INDENT 7.0 .TP @@ -481,7 +481,7 @@ contstructor .INDENT 7.0 .TP .B Parameters -\fBselection\fP (\fInxsrecconfig.Selection.Selection\fP) \-\- selection dictionary object +\fBselection\fP (\fInxsrecconfig.Selection.Selection\fP) – selection dictionary object .TP .B Returns selection keys @@ -497,7 +497,7 @@ converts selection from any version to any other .INDENT 7.0 .TP .B Parameters -\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- selection dictionary object +\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – selection dictionary object .UNINDENT .UNINDENT .INDENT 7.0 @@ -536,7 +536,7 @@ into (major, minor, patch) .INDENT 7.0 .TP .B Parameters -\fBselection\fP (\fInxsrecconfig.Selection.Selection\fP) \-\- selection dictionary object +\fBselection\fP (\fInxsrecconfig.Selection.Selection\fP) – selection dictionary object .TP .B Returns (major, minor, patch) tuple with integers @@ -561,7 +561,7 @@ converts selection from version 1 to 2 .INDENT 7.0 .TP .B Parameters -\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- selection dictionary object +\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – selection dictionary object .UNINDENT .UNINDENT .INDENT 7.0 @@ -590,7 +590,7 @@ converts selection from version 2 to 1 .INDENT 7.0 .TP .B Parameters -\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- selection dictionary object +\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – selection dictionary object .UNINDENT .UNINDENT .INDENT 7.0 @@ -619,7 +619,7 @@ converts selection from version 2 to 3 .INDENT 7.0 .TP .B Parameters -\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- selection dictionary object +\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – selection dictionary object .UNINDENT .UNINDENT .INDENT 7.0 @@ -634,7 +634,7 @@ converters list/dict of elements to dictionary with logical values .INDENT 7.0 .TP .B Parameters -\fBjselelem\fP (\fI\%str\fP) \-\- json list or dict selection element +\fBjselelem\fP (\fI\%str\fP) – json list or dict selection element .TP .B Returns json dictionary @@ -659,7 +659,7 @@ converts selection from version 3 to 2 .INDENT 7.0 .TP .B Parameters -\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- selection dictionary object +\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – selection dictionary object .UNINDENT .UNINDENT .INDENT 7.0 @@ -678,7 +678,7 @@ to dictionary with True/False values .INDENT 7.0 .TP .B Parameters -\fBjselelem\fP (\fI\%str\fP) \-\- json dictionary selection element +\fBjselelem\fP (\fI\%str\fP) – json dictionary selection element .TP .B Returns converter json dictionary @@ -698,7 +698,7 @@ to list of elementes with walue True .INDENT 7.0 .TP .B Parameters -\fBjselelem\fP (\fI\%str\fP) \-\- json dictionary selection element +\fBjselelem\fP (\fI\%str\fP) – json dictionary selection element .TP .B Returns converter json dictionary @@ -723,7 +723,7 @@ converts selection to the current selector version .INDENT 7.0 .TP .B Parameters -\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- selection dictionary object +\fBselection\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – selection dictionary object .UNINDENT .UNINDENT .INDENT 7.0 @@ -748,15 +748,15 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- datasource name +\fBname\fP (\fI\%str\fP) – datasource name .IP \(bu 2 -\fBdstype\fP (\fI\%str\fP) \-\- datasource type +\fBdstype\fP (\fI\%str\fP) – datasource type .IP \(bu 2 -\fBrecord\fP (\fI\%str\fP) \-\- datasource record +\fBrecord\fP (\fI\%str\fP) – datasource record .IP \(bu 2 -\fBdsitem\fP (\fI\%DSItem\fP) \-\- datasource item +\fBdsitem\fP (\fI\%DSItem\fP) – datasource item .IP \(bu 2 -\fBparentobj\fP (\fI\%str\fP) \-\- datasource parent object +\fBparentobj\fP (\fI\%str\fP) – datasource parent object .UNINDENT .UNINDENT .INDENT 7.0 @@ -794,11 +794,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBnexusconfig_device\fP (\fI\%tango.DeviceProxy\fP or \fI\%nxsconfigserver.XMLConfigurator.XMLConfigurator\fP) \-\- configserver configuration server +\fBnexusconfig_device\fP (\fI\%tango.DeviceProxy\fP or \fI\%nxsconfigserver.XMLConfigurator.XMLConfigurator\fP) – configserver configuration server .IP \(bu 2 -\fBtree\fP (\fI\%bool\fP) \-\- flag for output tree dictionary +\fBtree\fP (\fI\%bool\fP) – flag for output tree dictionary .IP \(bu 2 -\fBpyevalfromscript\fP (\fI\%bool\fP) \-\- if evalulate PYEVAL datasources from script +\fBpyevalfromscript\fP (\fI\%bool\fP) – if evalulate PYEVAL datasources from script .UNINDENT .UNINDENT .INDENT 7.0 @@ -806,13 +806,13 @@ constructor .B components(components=None, strategy=\(aq\(aq, dstype=\(aq\(aq, cfvars=None) describes given components. If \fBtree\fP = True it returns .nf -[{ cpname : { dsname : [ | (strategy, dstype, record, nxstype, shape), ...] } } ] +[{ cpname : { dsname : [ | (strategy, dstype, record, nxstype, shape), …] } } ] .fi .sp .sp else .nf -[{"dsname": dsname, "strategy": strategy, "dstype": dstype, | "record": record, "nxstype": nxstype, "shape": shape , | "cpname": cpname}, ...] +[{“dsname”: dsname, “strategy”: strategy, “dstype”: dstype, | “record”: record, “nxstype”: nxstype, “shape”: shape , | “cpname”: cpname}, …] .fi .sp .INDENT 7.0 @@ -820,23 +820,23 @@ else .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) \-\- given components. +\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) – given components. If None all available ones are taken .IP \(bu 2 -\fBstrategy\fP (\fI\%str\fP) \-\- list datasets only with given strategy. -If \(aq\(aq all available ones are taken +\fBstrategy\fP (\fI\%str\fP) – list datasets only with given strategy. +If ‘’ all available ones are taken .IP \(bu 2 -\fBdstype\fP (\fI\%str\fP) \-\- list datasets only with given datasource type. -If \(aq\(aq all available ones are taken +\fBdstype\fP (\fI\%str\fP) – list datasets only with given datasource type. +If ‘’ all available ones are taken .IP \(bu 2 -\fBcfvars\fP (\fI\%str\fP) \-\- configuration variables in JSON dictionary +\fBcfvars\fP (\fI\%str\fP) – configuration variables in JSON dictionary .UNINDENT .TP .B Returns list of dictionary with description of components .TP .B Return type -[\fI\%dict\fP <\fI\%str\fP, \fI\%dict\fP <\fI\%str\fP, \fI\%list\fP <(\fI\%str\fP, \fI\%str\fP, \fI\%str\fP, \fI\%str\fP, \fI\%list\fP <\fI\%int\fP>)> > > ] or [{"dsname": \fI\%str\fP, "strategy": \fI\%str\fP, "dstype": \fI\%str\fP, "record": \fI\%str\fP, "nxstype": \fI\%str\fP, "shape": \fI\%list\fP <\fI\%int\fP> , "cpname": \fI\%str\fP}, ...] +[\fI\%dict\fP <\fI\%str\fP, \fI\%dict\fP <\fI\%str\fP, \fI\%list\fP <(\fI\%str\fP, \fI\%str\fP, \fI\%str\fP, \fI\%str\fP, \fI\%list\fP <\fI\%int\fP>)> > > ] or [{“dsname”: \fI\%str\fP, “strategy”: \fI\%str\fP, “dstype”: \fI\%str\fP, “record”: \fI\%str\fP, “nxstype”: \fI\%str\fP, “shape”: \fI\%list\fP <\fI\%int\fP> , “cpname”: \fI\%str\fP}, …] .UNINDENT .UNINDENT .INDENT 7.0 @@ -848,18 +848,18 @@ describes given datasources .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) \-\- given datasources. +\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) – given datasources. If None all available ones are taken .IP \(bu 2 -\fBdstype\fP (\fI\%str\fP) \-\- list datasources only with given type. -If \(aq\(aq all available ones are taken +\fBdstype\fP (\fI\%str\fP) – list datasources only with given type. +If ‘’ all available ones are taken .UNINDENT .TP .B Returns list of dictionary with description of datasources .TP .B Return type -[\fI\%dict\fP <\fI\%str\fP, \fI\%ExDSDict\fP > ] or [{"dsname": \fI\%str\fP, "dstype": \fI\%str\fP, "record": \fI\%str\fP}, ...] +[\fI\%dict\fP <\fI\%str\fP, \fI\%ExDSDict\fP > ] or [{“dsname”: \fI\%str\fP, “dstype”: \fI\%str\fP, “record”: \fI\%str\fP}, …] .UNINDENT .UNINDENT .UNINDENT @@ -876,9 +876,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fIany\fP>) \-\- dict args +\fBargs\fP (\fI\%list\fP <\fIany\fP>) – dict args .IP \(bu 2 -\fBkw\fP (\fI\%dict\fP <\fIany\fP , \fIany\fP>) \-\- dict kw +\fBkw\fP (\fI\%dict\fP <\fIany\fP , \fIany\fP>) – dict kw .UNINDENT .UNINDENT .INDENT 7.0 @@ -890,13 +890,13 @@ appends a list of ExDSItem .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdslist\fP (\fI\%list\fP <\fI\%DSItem\fP>) \-\- DSItem list +\fBdslist\fP (\fI\%list\fP <\fI\%DSItem\fP>) – DSItem list .IP \(bu 2 -\fBmode\fP (\fI\%str\fP) \-\- startegy mode +\fBmode\fP (\fI\%str\fP) – startegy mode .IP \(bu 2 -\fBnxtype\fP \-\- NeXus type +\fBnxtype\fP – NeXus type .IP \(bu 2 -\fBshape\fP (\fI\%list\fP <\fI\%int\fP>) \-\- data shape +\fBshape\fP (\fI\%list\fP <\fI\%int\fP>) – data shape .UNINDENT .TP .B Returns @@ -921,13 +921,13 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdsitem\fP (\fI\%DSItem\fP) \-\- datasource item +\fBdsitem\fP (\fI\%DSItem\fP) – datasource item .IP \(bu 2 -\fBmode\fP (\fI\%str\fP) \-\- writing strategy mode +\fBmode\fP (\fI\%str\fP) – writing strategy mode .IP \(bu 2 -\fBnxtype\fP \-\- nexus type +\fBnxtype\fP – nexus type .IP \(bu 2 -\fBshape\fP (\fI\%list\fP <\fI\%int\fP>) \-\- datasource shape +\fBshape\fP (\fI\%list\fP <\fI\%int\fP>) – datasource shape .UNINDENT .UNINDENT .INDENT 7.0 @@ -963,9 +963,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBnexusconfig_device\fP (\fI\%tango.DeviceProxy\fP or \fI\%nxsconfigserver.XMLConfigurator.XMLConfigurator\fP) \-\- configserver configuration server +\fBnexusconfig_device\fP (\fI\%tango.DeviceProxy\fP or \fI\%nxsconfigserver.XMLConfigurator.XMLConfigurator\fP) – configserver configuration server .IP \(bu 2 -\fBdefaultpath\fP (\fI\%str\fP) \-\- default dynamic component path +\fBdefaultpath\fP (\fI\%str\fP) – default dynamic component path .UNINDENT .UNINDENT .INDENT 7.0 @@ -988,7 +988,7 @@ removes dynamic component .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- dynamic component name +\fBname\fP (\fI\%str\fP) – dynamic component name .UNINDENT .UNINDENT .INDENT 7.0 @@ -998,16 +998,16 @@ sets default nexus path and link flag for dynamic components .INDENT 7.0 .TP .B Brief -if dynamicPath is None or "" it is reset to default one +if dynamicPath is None or “” it is reset to default one .TP .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdynamicPath\fP (\fI\%str\fP) \-\- nexus default path +\fBdynamicPath\fP (\fI\%str\fP) – nexus default path .IP \(bu 2 -\fBdynamicLinks\fP (\fI\%bool\fP) \-\- default link flag +\fBdynamicLinks\fP (\fI\%bool\fP) – default link flag .IP \(bu 2 -\fBdynamicInitLinks\fP (\fI\%bool\fP) \-\- default link flag +\fBdynamicInitLinks\fP (\fI\%bool\fP) – default link flag .UNINDENT .UNINDENT .UNINDENT @@ -1018,7 +1018,7 @@ sets init datasources .INDENT 7.0 .TP .B Parameters -\fBdsources\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of init datasources +\fBdsources\fP (\fI\%list\fP <\fI\%str\fP>) – list of init datasources .UNINDENT .UNINDENT .INDENT 7.0 @@ -1030,15 +1030,15 @@ sets label parameters for specific dynamic components .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBlabels\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%str\fP>) \-\- label dictionaries +\fBlabels\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%str\fP>) – label dictionaries .IP \(bu 2 -\fBpaths\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%str\fP>) \-\- nexus path dictionaries +\fBpaths\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%str\fP>) – nexus path dictionaries .IP \(bu 2 -\fBlinks\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%bool\fP>) \-\- link dictionaries +\fBlinks\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%bool\fP>) – link dictionaries .IP \(bu 2 -\fBtypes\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%str\fP>) \-\- nexus type dictionaries +\fBtypes\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%str\fP>) – nexus type dictionaries .IP \(bu 2 -\fBshapes\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%list\fP <\fI\%int\fP> >) \-\- data shape dictionaries +\fBshapes\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%list\fP <\fI\%int\fP> >) – data shape dictionaries .UNINDENT .UNINDENT .UNINDENT @@ -1049,7 +1049,7 @@ sets step datasources .INDENT 7.0 .TP .B Parameters -\fBdsources\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of step datasources +\fBdsources\fP (\fI\%list\fP <\fI\%str\fP>) – list of step datasources .UNINDENT .UNINDENT .INDENT 7.0 @@ -1059,8 +1059,8 @@ sets user datasources with type and shape .INDENT 7.0 .TP .B Parameters -\fBdctlist\fP (\fI\%str\fP) \-\- json list of parameter dictionaries -[{"name": , "dtype": , "shape":}, ...] +\fBdctlist\fP (\fI\%str\fP) – json list of parameter dictionaries +[{“name”: , “dtype”: , “shape”:}, …] .UNINDENT .UNINDENT .UNINDENT @@ -1078,7 +1078,7 @@ constructor .INDENT 7.0 .TP .B Parameters -\fBnumberOfThreads\fP (\fI\%str\fP) \-\- number of threads +\fBnumberOfThreads\fP (\fI\%str\fP) – number of threads .UNINDENT .INDENT 7.0 .TP @@ -1089,15 +1089,15 @@ checks component channels .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdoor\fP (\fI\%str\fP) \-\- door device name +\fBdoor\fP (\fI\%str\fP) – door device name .IP \(bu 2 -\fBconfigdevice\fP (\fI\%tango.DeviceProxy\fP or \fI\%nxsconfigserver.XMLConfigurator.XMLConfigurator\fP) \-\- configuration server +\fBconfigdevice\fP (\fI\%tango.DeviceProxy\fP or \fI\%nxsconfigserver.XMLConfigurator.XMLConfigurator\fP) – configuration server .IP \(bu 2 -\fBchannels\fP (\fI\%list\fP <\fI\%str\fP>) \-\- pool channels +\fBchannels\fP (\fI\%list\fP <\fI\%str\fP>) – pool channels .IP \(bu 2 -\fBcomponentgroup\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%bool\fP>) \-\- preselected component group +\fBcomponentgroup\fP (\fI\%dict\fP <\fI\%str\fP , \fI\%bool\fP>) – preselected component group .IP \(bu 2 -\fBchannelerrors\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of deactivated component errors +\fBchannelerrors\fP (\fI\%list\fP <\fI\%str\fP>) – list of deactivated component errors .UNINDENT .TP .B Returns @@ -1114,7 +1114,7 @@ door macro server device name .INDENT 7.0 .TP .B Parameters -\fBdoor\fP (\fI\%str\fP) \-\- door device name +\fBdoor\fP (\fI\%str\fP) – door device name .TP .B Returns macroserver device name @@ -1130,7 +1130,7 @@ door pool device proxies .INDENT 7.0 .TP .B Parameters -\fBdoor\fP (\fI\%str\fP) \-\- door device name +\fBdoor\fP (\fI\%str\fP) – door device name .TP .B Returns pool device proxies @@ -1146,7 +1146,7 @@ fetches Scan Environment Data .INDENT 7.0 .TP .B Parameters -\fBdoor\fP (\fI\%str\fP) \-\- door device +\fBdoor\fP (\fI\%str\fP) – door device .TP .B Returns JSON String with important variables @@ -1164,11 +1164,11 @@ imports Environment Data .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdoor\fP (\fI\%str\fP) \-\- door device +\fBdoor\fP (\fI\%str\fP) – door device .IP \(bu 2 -\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) \-\- names of required variables +\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) – names of required variables .IP \(bu 2 -\fBdata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) \-\- dictionary with resulting data +\fBdata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) – dictionary with resulting data .UNINDENT .UNINDENT .UNINDENT @@ -1179,7 +1179,7 @@ check if any door server is running .INDENT 7.0 .TP .B Parameters -\fBms\fP (\fI\%str\fP) \-\- macroserver device name +\fBms\fP (\fI\%str\fP) – macroserver device name .TP .B Returns if any door running @@ -1202,9 +1202,9 @@ stores Scan Environment Data .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdoor\fP (\fI\%str\fP) \-\- door device +\fBdoor\fP (\fI\%str\fP) – door device .IP \(bu 2 -\fBjdata\fP (\fI\%str\fP) \-\- JSON String with important variables +\fBjdata\fP (\fI\%str\fP) – JSON String with important variables .UNINDENT .UNINDENT .UNINDENT @@ -1217,11 +1217,11 @@ exports all Environment Data .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdoor\fP (\fI\%str\fP) \-\- door device +\fBdoor\fP (\fI\%str\fP) – door device .IP \(bu 2 -\fBdata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) \-\- data dictionary +\fBdata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) – data dictionary .IP \(bu 2 -\fBcmddata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) \-\- command data dictionary +\fBcmddata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) – command data dictionary .UNINDENT .UNINDENT .UNINDENT @@ -1242,7 +1242,7 @@ updates MacroServer and sardana pools for given door .INDENT 7.0 .TP .B Parameters -\fBdoor\fP (\fI\%str\fP) \-\- door device name +\fBdoor\fP (\fI\%str\fP) – door device name .TP .B Returns macroserver device name @@ -1276,9 +1276,9 @@ Device constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBcl\fP (\fI\%str\fP) \-\- class name +\fBcl\fP (\fI\%str\fP) – class name .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- device name +\fBname\fP (\fI\%str\fP) – device name .UNINDENT .UNINDENT .INDENT 7.0 @@ -1291,7 +1291,7 @@ AddStepDataSources command switch datasources to step mode .TP .B Parameters -\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) \-\- DevVarStringArray list of datasource names +\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) – DevVarStringArray list of datasource names .TP .B Returns DevVarStringArray list of datasources not found in components @@ -1407,7 +1407,7 @@ Provide JSON dictionary with channel properties {channel:property} .TP .B Parameters -\fBargin\fP (\fI\%str\fP) \-\- DevString property type +\fBargin\fP (\fI\%str\fP) – DevString property type .TP .B Returns DevString JSON dictionary with channel properties @@ -1426,7 +1426,7 @@ ComponentClientSources command Describe client datasources from components .TP .B Parameters -\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) \-\- DevVarStringArray list of component names +\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) – DevVarStringArray list of component names .TP .B Returns DevVarString description of component datasources @@ -1477,7 +1477,7 @@ ComponentSources command Describe datasources from components .TP .B Parameters -\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) \-\- DevVarStringArray list of component names +\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) – DevVarStringArray list of component names .TP .B Returns DevVarString description of component datasources @@ -1493,7 +1493,7 @@ It creates new DataSources on the ConfigServer .INDENT 7.0 .TP .B Parameters -\fBargin\fP (\fI\%str\fP) \-\- JSON dictionary with {\fBdsname\fP: \fBtangosource\fP, ...} +\fBargin\fP (\fI\%str\fP) – JSON dictionary with {\fBdsname\fP: \fBtangosource\fP, …} .UNINDENT .UNINDENT .INDENT 7.0 @@ -1506,7 +1506,7 @@ CreateDynamicComponent command Create dynamic component .TP .B Parameters -\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) \-\- DevVarStringArray list of datasource parameters +\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) – DevVarStringArray list of datasource parameters .TP .B Returns DevVarString name of created dynamic component @@ -1525,7 +1525,7 @@ CreateWriterConfiguration command Create configuration from the given components .TP .B Parameters -\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) \-\- DevVarStringArray list of component names +\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) – DevVarStringArray list of component names .TP .B Returns DevVarString XML configuration string @@ -1544,7 +1544,7 @@ DataSourceDescription command Provide datasource description .TP .B Parameters -\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) \-\- DevVarStringArray list of datasource names +\fBargin\fP (\fI\%list\fP <\fI\%str\fP>) – DevVarStringArray list of datasource names .TP .B Returns DevVarStringArray description of datasources @@ -1573,7 +1573,7 @@ DeleteProfile command Delete the given mntgrp .TP .B Parameters -\fBargin\fP (\fI\%str\fP) \-\- DevString measurement group name +\fBargin\fP (\fI\%str\fP) – DevString measurement group name .UNINDENT .UNINDENT .INDENT 7.0 @@ -1713,7 +1713,7 @@ PoolElementNames command Return a list of available pool channels .TP .B Parameters -\fBargin\fP (\fI\%str\fP) \-\- DevString name of pool list attribute +\fBargin\fP (\fI\%str\fP) – DevString name of pool list attribute .TP .B Returns DevVarStringArray list of available pool elements @@ -1774,7 +1774,7 @@ RemoveDynamicComponent command Delete the given dynamic component .TP .B Parameters -\fBargin\fP (\fI\%str\fP) \-\- DevString dynamic component name +\fBargin\fP (\fI\%str\fP) – DevString dynamic component name .UNINDENT .UNINDENT .INDENT 7.0 @@ -1857,7 +1857,7 @@ SetChannelProperties command SetChannelProperties Set Channel Properties of the given type .TP .B Parameters -\fBargin\fP ([\fI\%str\fP, \fI\%str\fP]) \-\- DevVarStringArray two element list with a property type +\fBargin\fP ([\fI\%str\fP, \fI\%str\fP]) – DevVarStringArray two element list with a property type and JSON value dictionary {channel:property} .UNINDENT .UNINDENT @@ -1872,7 +1872,7 @@ Store ScanDir, ScanFile and NeXusSelectorDevice in environment variables .TP .B Parameters -\fBargin\fP (\fI\%str\fP) \-\- json dictionary with environment data +\fBargin\fP (\fI\%str\fP) – json dictionary with environment data .TP .B Returns DevLong scan ID @@ -2598,7 +2598,7 @@ Read AppendEntry attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2608,7 +2608,7 @@ Read CanFailDataSources attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2618,7 +2618,7 @@ Read Components attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2628,7 +2628,7 @@ Read ConfigDevice attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2638,7 +2638,7 @@ Read ConfigVariables attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2648,7 +2648,7 @@ Read DataSources attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2658,7 +2658,7 @@ Read DescriptionErrors attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2668,7 +2668,7 @@ Read DeviceGroups attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2678,7 +2678,7 @@ Read Door attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2688,7 +2688,7 @@ Read LinkDataSources attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2698,7 +2698,7 @@ Read MacroServer attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2708,7 +2708,7 @@ Read MntGrp attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2718,7 +2718,7 @@ Read ProfileConfiguration attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2728,7 +2728,7 @@ Read ProfileFile attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2738,7 +2738,7 @@ Read ScanDir attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2748,7 +2748,7 @@ Read ScanFile attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2758,7 +2758,7 @@ Read ScanID attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2768,7 +2768,7 @@ Read StepDataSources attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2778,7 +2778,7 @@ Read UserData attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2788,7 +2788,7 @@ Read Version attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2798,7 +2798,7 @@ Read WriterDevice attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- read attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – read attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2813,7 +2813,7 @@ Write AppendEntry attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2823,7 +2823,7 @@ Write CanFailDataSources attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2833,7 +2833,7 @@ Write ConfigDevice attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2843,7 +2843,7 @@ Write ConfigVariables attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2853,7 +2853,7 @@ Write DeviceGroups attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2863,7 +2863,7 @@ Write Door attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2873,7 +2873,7 @@ Write LinkDataSources attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2883,7 +2883,7 @@ Write MntGrp attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2893,7 +2893,7 @@ Write ProfileConfiguration attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2903,7 +2903,7 @@ Write ProfileFile attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2913,7 +2913,7 @@ Write ScanDir attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2923,7 +2923,7 @@ Write ScanFile attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2933,7 +2933,7 @@ Write ScanID attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2943,7 +2943,7 @@ Write StepDataSources attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2953,7 +2953,7 @@ Write UserData attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .INDENT 7.0 @@ -2963,7 +2963,7 @@ Write WriterDevice attribute .INDENT 7.0 .TP .B Parameters -\fBattr\fP (\fI\%tango.Attribute\fP) \-\- written attribute +\fBattr\fP (\fI\%tango.Attribute\fP) – written attribute .UNINDENT .UNINDENT .UNINDENT @@ -3020,11 +3020,11 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBselector\fP (\fI\%nxsrecconfig.Selector.Selector\fP) \-\- selector object +\fBselector\fP (\fI\%nxsrecconfig.Selector.Selector\fP) – selector object .IP \(bu 2 -\fBsyncsnapshot\fP (\fI\%bool\fP) \-\- preselection merges current ScanSnapshot +\fBsyncsnapshot\fP (\fI\%bool\fP) – preselection merges current ScanSnapshot .IP \(bu 2 -\fBwritepoolmotorpositions\fP (\fI\%bool\fP) \-\- add dynamic components +\fBwritepoolmotorpositions\fP (\fI\%bool\fP) – add dynamic components for all pool motor positions .UNINDENT .UNINDENT @@ -3079,14 +3079,14 @@ provides description of components .INDENT 7.0 .TP .B Parameters -\fBfull\fP (\fI\%bool\fP) \-\- if True describes all available ones are taken +\fBfull\fP (\fI\%bool\fP) – if True describes all available ones are taken otherwise selectect, preselected and mandatory .TP .B Returns description of required components .TP .B Return type -[\fI\%dict\fP <\fI\%str\fP, \fI\%dict\fP <\fI\%str\fP, \fI\%list\fP <(\fI\%str\fP, \fI\%str\fP, \fI\%str\fP, \fI\%str\fP, \fI\%list\fP <\fI\%int\fP>)> > > ] or [{"dsname": \fI\%str\fP, "strategy": \fI\%str\fP, "dstype": \fI\%str\fP, "record": \fI\%str\fP, "nxstype": \fI\%str\fP, "shape": \fI\%list\fP <\fI\%int\fP> , "cpname": \fI\%str\fP}, ...] +[\fI\%dict\fP <\fI\%str\fP, \fI\%dict\fP <\fI\%str\fP, \fI\%list\fP <(\fI\%str\fP, \fI\%str\fP, \fI\%str\fP, \fI\%str\fP, \fI\%list\fP <\fI\%int\fP>)> > > ] or [{“dsname”: \fI\%str\fP, “strategy”: \fI\%str\fP, “dstype”: \fI\%str\fP, “record”: \fI\%str\fP, “nxstype”: \fI\%str\fP, “shape”: \fI\%list\fP <\fI\%int\fP> , “cpname”: \fI\%str\fP}, …] .UNINDENT .UNINDENT .INDENT 7.0 @@ -3098,10 +3098,10 @@ adds known and creates unknown datasources .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBtangods\fP (\fI\%list\fP < [\fI\%str\fP , \fI\%str\fP , \fI\%str\fP ] >) \-\- tango datasources list +\fBtangods\fP (\fI\%list\fP < [\fI\%str\fP , \fI\%str\fP , \fI\%str\fP ] >) – tango datasources list with elements (name, label, source) .IP \(bu 2 -\fBdsg\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%bool\fP or \fINone\fP>) \-\- datasource selection dictionary +\fBdsg\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%bool\fP or \fINone\fP>) – datasource selection dictionary .UNINDENT .TP .B Returns @@ -3136,7 +3136,7 @@ deletes mntgrp .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- mntgrp name +\fBname\fP (\fI\%str\fP) – mntgrp name .UNINDENT .UNINDENT .INDENT 7.0 @@ -3236,7 +3236,7 @@ switchProfile to active measurement .INDENT 7.0 .TP .B Parameters -\fBtoActive\fP (\fI\%bool\fP) \-\- if False update the current profile +\fBtoActive\fP (\fI\%bool\fP) – if False update the current profile .UNINDENT .UNINDENT .INDENT 7.0 @@ -3254,9 +3254,9 @@ import setting from active measurement .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBsync\fP (\fI\%bool\fP) \-\- make profile and mntgrp synchronization +\fBsync\fP (\fI\%bool\fP) – make profile and mntgrp synchronization .IP \(bu 2 -\fBsync\fP \-\- reset door device name flag +\fBsync\fP – reset door device name flag .UNINDENT .TP .B Returns @@ -3280,30 +3280,30 @@ Bases: \fI\%dict\fP .sp Selection Dictionary which contains the following records: { -"Timer": \(aq[]\(aq, -"OrderedChannels": \(aq[]\(aq, -"ComponentSelection": \(aq{}\(aq, -"DataSourceSelection": \(aq{}\(aq, -"DataSourcePreselection": \(aq{}\(aq, -"ComponentPreselection": \(aq{}\(aq, -"PreselectingDataSources": \(aq[]\(aq, -"OptionalComponents": \(aq[]\(aq, -"AppendEntry": False, -"ComponentsFromMntGrp": False, -"ConfigVariables": \(aq{}\(aq, -"UserData": \(aq{}\(aq, -"ChannelProperties": \(aq{}\(aq, -"UnplottedComponents": \(aq[]\(aq, -"DynamicComponents": True, -"DefaultDynamicLinks": True, -"DefaultDynamicPath": \(aq/$var.entryname#\(aqscan\(aq$var.serialno:NXentry/NXinstrument/collection\(aq, -"TimeZone": self.__defaultzone, -"ConfigDevice": \(aq\(aq, -"WriterDevice": \(aq\(aq, -"Door": \(aq\(aq, -"MntGrp": \(aq\(aq, -"Version": self.__version, -"MntGrpConfiguration": \(aq\(aq +“Timer”: ‘[]’, +“OrderedChannels”: ‘[]’, +“ComponentSelection”: ‘{}’, +“DataSourceSelection”: ‘{}’, +“DataSourcePreselection”: ‘{}’, +“ComponentPreselection”: ‘{}’, +“PreselectingDataSources”: ‘[]’, +“OptionalComponents”: ‘[]’, +“AppendEntry”: False, +“ComponentsFromMntGrp”: False, +“ConfigVariables”: ‘{}’, +“UserData”: ‘{}’, +“ChannelProperties”: ‘{}’, +“UnplottedComponents”: ‘[]’, +“DynamicComponents”: True, +“DefaultDynamicLinks”: True, +“DefaultDynamicPath”: ‘/$var.entryname#’scan’$var.serialno:NXentry/NXinstrument/collection’, +“TimeZone”: self.__defaultzone, +“ConfigDevice”: ‘’, +“WriterDevice”: ‘’, +“Door”: ‘’, +“MntGrp”: ‘’, +“Version”: self.__version, +“MntGrpConfiguration”: ‘’ } .sp constructor @@ -3312,9 +3312,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBargs\fP (\fI\%list\fP <\fIany\fP>) \-\- dictionary args +\fBargs\fP (\fI\%list\fP <\fIany\fP>) – dictionary args .IP \(bu 2 -\fBkw\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- dictionary kw +\fBkw\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – dictionary kw .UNINDENT .UNINDENT .INDENT 7.0 @@ -3367,9 +3367,9 @@ sets pool channels in order defined by OrderedChannels .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdevicecontrollers\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%str\fP>) \-\- device controller dictionary +\fBdevicecontrollers\fP (\fI\%dict\fP <\fI\%str\fP, \fI\%str\fP>) – device controller dictionary .IP \(bu 2 -\fBtriggergate\fP (\fI\%list\fP <\fI\%str\fP>) \-\- trigger gate list +\fBtriggergate\fP (\fI\%list\fP <\fI\%str\fP>) – trigger gate list .UNINDENT .UNINDENT .UNINDENT @@ -3397,9 +3397,9 @@ It adds new channels to DataSourceSelection .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBchannels\fP (\fI\%list\fP <\fI\%str\fP>) \-\- pool channels +\fBchannels\fP (\fI\%list\fP <\fI\%str\fP>) – pool channels .IP \(bu 2 -\fBdatasources\fP (\fI\%list\fP <\fI\%str\fP>) \-\- available datasources +\fBdatasources\fP (\fI\%list\fP <\fI\%str\fP>) – available datasources .UNINDENT .UNINDENT .UNINDENT @@ -3413,7 +3413,7 @@ update method for orderedChannels attribute sets pool channels in order defined by OrderedChannels .TP .B Parameters -\fBchannels\fP (\fI\%list\fP <\fI\%str\fP>) \-\- pool channels +\fBchannels\fP (\fI\%list\fP <\fI\%str\fP>) – pool channels .UNINDENT .UNINDENT .INDENT 7.0 @@ -3426,7 +3426,7 @@ update method for Preselected DataSources appends new datasources to Preselected DataSources .TP .B Parameters -\fBdatasources\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list of datasources +\fBdatasources\fP (\fI\%list\fP <\fI\%str\fP>) – list of datasources .UNINDENT .UNINDENT .UNINDENT @@ -3446,17 +3446,17 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmacroserverpools\fP (\fI\%nxsrecconfig.MacroServerPools.MacroServerPools\fP) \-\- MacroServerPools object +\fBmacroserverpools\fP (\fI\%nxsrecconfig.MacroServerPools.MacroServerPools\fP) – MacroServerPools object .IP \(bu 2 -\fBversion\fP (\fI\%str\fP) \-\- selector version +\fBversion\fP (\fI\%str\fP) – selector version .IP \(bu 2 -\fBdefaultpath\fP (\fI\%str\fP) \-\- default dynamic component path +\fBdefaultpath\fP (\fI\%str\fP) – default dynamic component path .IP \(bu 2 -\fBdefaultpath\fP \-\- default dynamic component path +\fBdefaultpath\fP – default dynamic component path .IP \(bu 2 -\fBdefaulttimezone\fP (\fI\%str\fP) \-\- default time zone +\fBdefaulttimezone\fP (\fI\%str\fP) – default time zone .IP \(bu 2 -\fBdefaultmntgrp\fP (\fI\%str\fP) \-\- default measurement group name +\fBdefaultmntgrp\fP (\fI\%str\fP) – default measurement group name .UNINDENT .UNINDENT .INDENT 7.0 @@ -3468,9 +3468,9 @@ executes command on configuration server .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBcommand\fP (\fI\%str\fP) \-\- command name +\fBcommand\fP (\fI\%str\fP) – command name .IP \(bu 2 -\fBvar\fP ([ \fIany\fP ]) \-\- parameter list +\fBvar\fP ([ \fIany\fP ]) – parameter list .UNINDENT .TP .B Returns @@ -3499,9 +3499,9 @@ exports Selector Environment Data .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) \-\- dictionary with input data +\fBdata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) – dictionary with input data .IP \(bu 2 -\fBcmddata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) \-\- dictionary with command input data +\fBcmddata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) – dictionary with command input data .UNINDENT .UNINDENT .UNINDENT @@ -3579,9 +3579,9 @@ imports Selector Environment Data .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) \-\- names of required variables +\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) – names of required variables .IP \(bu 2 -\fBdata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) \-\- dictionary with resulting data +\fBdata\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) – dictionary with resulting data .UNINDENT .UNINDENT .UNINDENT @@ -3623,7 +3623,7 @@ provides names from the given pool listattr .INDENT 7.0 .TP .B Parameters -\fBlistattr\fP (\fI\%str\fP) \-\- pool attribute with list +\fBlistattr\fP (\fI\%str\fP) – pool attribute with list .TP .B Returns names from given pool listattr @@ -3654,7 +3654,7 @@ resets preselected components to set of given components .INDENT 7.0 .TP .B Parameters -\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) \-\- new selection preselected components +\fBcomponents\fP (\fI\%list\fP <\fI\%str\fP>) – new selection preselected components .UNINDENT .UNINDENT .INDENT 7.0 @@ -3664,7 +3664,7 @@ sets selection from state data .INDENT 7.0 .TP .B Parameters -\fBstate\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) \-\- state data +\fBstate\fP (\fI\%dict\fP <\fI\%str\fP, \fIany\fP>) – state data .UNINDENT .UNINDENT .INDENT 7.0 @@ -3687,7 +3687,7 @@ sets Scan Environment Data .INDENT 7.0 .TP .B Parameters -\fBjdata\fP (\fI\%str\fP) \-\- JSON String with important variables +\fBjdata\fP (\fI\%str\fP) – JSON String with important variables .UNINDENT .UNINDENT .INDENT 7.0 @@ -3712,20 +3712,20 @@ contructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBserver\fP (\fI\%nxsrecconfig.NXSConfig.NXSRecSelector\fP) \-\- NXSRecSelector server +\fBserver\fP (\fI\%nxsrecconfig.NXSConfig.NXSRecSelector\fP) – NXSRecSelector server .IP \(bu 2 -\fBnumberofthreads\fP (\fI\%str\fP) \-\- number of threads used to check device state +\fBnumberofthreads\fP (\fI\%str\fP) – number of threads used to check device state .IP \(bu 2 -\fBdefaultnexuspath\fP (\fI\%str\fP) \-\- default dynamic component path +\fBdefaultnexuspath\fP (\fI\%str\fP) – default dynamic component path .IP \(bu 2 -\fBsyncsnapshot\fP (\fI\%bool\fP) \-\- preselection merges current ScanSnapshot +\fBsyncsnapshot\fP (\fI\%bool\fP) – preselection merges current ScanSnapshot .IP \(bu 2 -\fBwritepoolmotorpositions\fP (\fI\%bool\fP) \-\- add dynamic components +\fBwritepoolmotorpositions\fP (\fI\%bool\fP) – add dynamic components for all pool motor positions .IP \(bu 2 -\fBdefaultnexustype\fP (\fI\%str\fP) \-\- default dynamic component nexus type +\fBdefaultnexustype\fP (\fI\%str\fP) – default dynamic component nexus type .IP \(bu 2 -\fBdefaultudatapath\fP (\fI\%str\fP) \-\- default user data dynamic component path +\fBdefaultudatapath\fP (\fI\%str\fP) – default user data dynamic component path .UNINDENT .UNINDENT .INDENT 7.0 @@ -3735,7 +3735,7 @@ describe datasources .INDENT 7.0 .TP .B Parameters -\fBdatasources\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list for datasource names +\fBdatasources\fP (\fI\%list\fP <\fI\%str\fP>) – list for datasource names .TP .B Returns list of datasources not found in components @@ -3844,7 +3844,7 @@ provides channel properties of the given type .INDENT 7.0 .TP .B Parameters -\fBptype\fP (\fI\%str\fP) \-\- property type +\fBptype\fP (\fI\%str\fP) – property type .TP .B Returns json dictionary with channel properties @@ -3865,7 +3865,7 @@ provides description of client datasources .INDENT 7.0 .TP .B Parameters -\fBcps\fP (\fI\%list\fP <\fI\%str\fP>) \-\- component names +\fBcps\fP (\fI\%list\fP <\fI\%str\fP>) – component names .TP .B Returns JSON string with description of client datasources @@ -3907,7 +3907,7 @@ provides description of datasources .INDENT 7.0 .TP .B Parameters -\fBcps\fP (\fI\%list\fP <\fI\%str\fP>) \-\- component names +\fBcps\fP (\fI\%list\fP <\fI\%str\fP>) – component names .TP .B Returns JSON string with description of client datasources @@ -3938,8 +3938,8 @@ describe datasources .INDENT 7.0 .TP .B Parameters -\fBdatasources\fP (\fI\%str\fP) \-\- JSON dictionary with -{\fBdsname\fP: \fBtangosource\fP, ...} +\fBdatasources\fP (\fI\%str\fP) – JSON dictionary with +{\fBdsname\fP: \fBtangosource\fP, …} .UNINDENT .UNINDENT .INDENT 7.0 @@ -3949,7 +3949,7 @@ creates dynamic component .INDENT 7.0 .TP .B Parameters -\fBparams\fP (\fI\%list\fP <\fI\%str\fP>) \-\- datasource parameters +\fBparams\fP (\fI\%list\fP <\fI\%str\fP>) – datasource parameters .TP .B Returns dynamic component name @@ -3965,7 +3965,7 @@ create configuration and clean stepdatasources and linkdatasources .INDENT 7.0 .TP .B Parameters -\fBcps\fP (\fI\%list\fP <\fI\%str\fP>) \-\- component names +\fBcps\fP (\fI\%list\fP <\fI\%str\fP>) – component names .TP .B Returns JSON string with description of client datasources @@ -3981,13 +3981,13 @@ describe datasources .INDENT 7.0 .TP .B Parameters -\fBdatasources\fP (\fI\%list\fP <\fI\%str\fP>) \-\- list for datasource names +\fBdatasources\fP (\fI\%list\fP <\fI\%str\fP>) – list for datasource names .TP .B Returns list of dictionary with description of datasources .TP .B Return type -[{"dsname": \fI\%str\fP, "dstype": \fI\%str\fP, "record": \fI\%str\fP}, ...] +[{“dsname”: \fI\%str\fP, “dstype”: \fI\%str\fP, “record”: \fI\%str\fP}, …] .UNINDENT .UNINDENT .INDENT 7.0 @@ -4042,7 +4042,7 @@ deletes mntgrp .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- mntgrp name +\fBname\fP (\fI\%str\fP) – mntgrp name .UNINDENT .UNINDENT .INDENT 7.0 @@ -4220,7 +4220,7 @@ provides names from given pool listattr .INDENT 7.0 .TP .B Parameters -\fBlistattr\fP (\fI\%str\fP) \-\- name of pool attribute with a element list +\fBlistattr\fP (\fI\%str\fP) – name of pool attribute with a element list .TP .B Returns names from given pool listattr @@ -4277,7 +4277,7 @@ removes dynamic component .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- dynamic component name +\fBname\fP (\fI\%str\fP) – dynamic component name .UNINDENT .UNINDENT .INDENT 7.0 @@ -4353,7 +4353,7 @@ sets channel properties of the given type .INDENT 7.0 .TP .B Parameters -\fBtypeandvariables\fP ((\fI\%str\fP, \fI\%str\fP)) \-\- (property type, json dictionary of channel propertie values) +\fBtypeandvariables\fP ((\fI\%str\fP, \fI\%str\fP)) – (property type, json dictionary of channel propertie values) .UNINDENT .UNINDENT .INDENT 7.0 @@ -4363,7 +4363,7 @@ sets Scan Environment Data .INDENT 7.0 .TP .B Parameters -\fBjdata\fP (\fI\%str\fP) \-\- JSON String with important variables +\fBjdata\fP (\fI\%str\fP) – JSON String with important variables .UNINDENT .UNINDENT .INDENT 7.0 @@ -4383,7 +4383,7 @@ switch to active measurement .INDENT 7.0 .TP .B Parameters -\fBtoActive\fP (\fI\%bool\fP) \-\- if False update the current profile +\fBtoActive\fP (\fI\%bool\fP) – if False update the current profile .UNINDENT .UNINDENT .INDENT 7.0 @@ -4450,7 +4450,7 @@ provides values of the required variable .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- name of the required variable +\fBname\fP (\fI\%str\fP) – name of the required variable .TP .B Returns values of the required variable @@ -4500,7 +4500,7 @@ streamset constractor .INDENT 7.0 .TP .B Parameters -\fBstreams\fP (\fI\%StreamSet\fP or \fI\%tango.LatestDeviceImpl\fP) \-\- tango\-like steamset class +\fBstreams\fP (\fI\%StreamSet\fP or \fI\%tango.LatestDeviceImpl\fP) – tango\-like steamset class .UNINDENT .INDENT 7.0 .TP @@ -4511,9 +4511,9 @@ writes debug message .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmessage\fP (\fI\%str\fP) \-\- debug message +\fBmessage\fP (\fI\%str\fP) – debug message .IP \(bu 2 -\fBstd\fP (\fI\%bool\fP) \-\- True if it writes to sys stream +\fBstd\fP (\fI\%bool\fP) – True if it writes to sys stream when log stream does not exist .UNINDENT .UNINDENT @@ -4527,9 +4527,9 @@ writes error message .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmessage\fP (\fI\%str\fP) \-\- error message +\fBmessage\fP (\fI\%str\fP) – error message .IP \(bu 2 -\fBstd\fP (\fI\%bool\fP) \-\- True if it writes to sys stream +\fBstd\fP (\fI\%bool\fP) – True if it writes to sys stream when log stream does not exist .UNINDENT .UNINDENT @@ -4543,9 +4543,9 @@ writes fatal error message .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmessage\fP (\fI\%str\fP) \-\- error message +\fBmessage\fP (\fI\%str\fP) – error message .IP \(bu 2 -\fBstd\fP (\fI\%bool\fP) \-\- True if it writes to sys stream +\fBstd\fP (\fI\%bool\fP) – True if it writes to sys stream when log stream does not exist .UNINDENT .UNINDENT @@ -4559,9 +4559,9 @@ writes info message .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmessage\fP (\fI\%str\fP) \-\- info message +\fBmessage\fP (\fI\%str\fP) – info message .IP \(bu 2 -\fBstd\fP (\fI\%bool\fP) \-\- True if it writes to sys stream +\fBstd\fP (\fI\%bool\fP) – True if it writes to sys stream when log stream does not exist .UNINDENT .UNINDENT @@ -4600,9 +4600,9 @@ writes warning message .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBmessage\fP (\fI\%str\fP) \-\- warning message +\fBmessage\fP (\fI\%str\fP) – warning message .IP \(bu 2 -\fBstd\fP (\fI\%bool\fP) \-\- True if it writes to sys stream +\fBstd\fP (\fI\%bool\fP) – True if it writes to sys stream when log stream does not exist .UNINDENT .UNINDENT @@ -4626,9 +4626,9 @@ provides environment variable value .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvar\fP (\fI\%str\fP) \-\- variable name +\fBvar\fP (\fI\%str\fP) – variable name .IP \(bu 2 -\fBms\fP (\fI\%str\fP) \-\- macroserver +\fBms\fP (\fI\%str\fP) – macroserver .UNINDENT .TP .B Returns @@ -4647,11 +4647,11 @@ provides macro server of given door .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdb\fP (\fI\%tango.Database\fP) \-\- tango database +\fBdb\fP (\fI\%tango.Database\fP) – tango database .IP \(bu 2 -\fBdoor\fP (\fI\%str\fP) \-\- given door +\fBdoor\fP (\fI\%str\fP) – given door .IP \(bu 2 -\fBfind\fP (\fI\%bool\fP) \-\- find new macroserver if door does not exist +\fBfind\fP (\fI\%bool\fP) – find new macroserver if door does not exist .UNINDENT .TP .B Returns @@ -4670,11 +4670,11 @@ sets environment variable value .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvar\fP (\fI\%str\fP) \-\- variable name +\fBvar\fP (\fI\%str\fP) – variable name .IP \(bu 2 -\fBvalue\fP (\fIany\fP) \-\- variable value +\fBvalue\fP (\fIany\fP) – variable value .IP \(bu 2 -\fBms\fP (\fI\%str\fP) \-\- macroserver +\fBms\fP (\fI\%str\fP) – macroserver .UNINDENT .UNINDENT .UNINDENT @@ -4687,9 +4687,9 @@ sets environment variable value .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvarvalues\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) \-\- variable value dictionary +\fBvarvalues\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP>) – variable value dictionary .IP \(bu 2 -\fBms\fP (\fI\%str\fP) \-\- macroserver +\fBms\fP (\fI\%str\fP) – macroserver .UNINDENT .UNINDENT .UNINDENT @@ -4702,9 +4702,9 @@ unsets environment variable .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvar\fP (\fI\%str\fP) \-\- variable name +\fBvar\fP (\fI\%str\fP) – variable name .IP \(bu 2 -\fBms\fP (\fI\%str\fP) \-\- macroserver +\fBms\fP (\fI\%str\fP) – macroserver .UNINDENT .UNINDENT .UNINDENT @@ -4717,9 +4717,9 @@ sets environment variable value .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP> or \fIany\fP) \-\- variable value dictionary +\fBvalue\fP (\fI\%dict\fP <\fI\%str\fP , \fIany\fP> or \fIany\fP) – variable value dictionary .IP \(bu 2 -\fBdp\fP (\fI\%str\fP) \-\- macroserver +\fBdp\fP (\fI\%str\fP) – macroserver .UNINDENT .UNINDENT .UNINDENT @@ -4751,9 +4751,9 @@ provides channels of given pools .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) \-\- list of pool devices +\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) – list of pool devices .IP \(bu 2 -\fBfilters\fP (\fI\%list\fP <\fI\%str\fP>) \-\- device name filter list +\fBfilters\fP (\fI\%list\fP <\fI\%str\fP>) – device name filter list .UNINDENT .TP .B Returns @@ -4772,9 +4772,9 @@ provides channels of given pools .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBlst\fP (\fI\%list\fP <\fI\%str\fP or (\fI\%str\fP, \fI\%str\fP)>) \-\- list of strings to filter out +\fBlst\fP (\fI\%list\fP <\fI\%str\fP or (\fI\%str\fP, \fI\%str\fP)>) – list of strings to filter out .IP \(bu 2 -\fBfilters\fP (\fI\%list\fP <\fI\%str\fP>) \-\- device name filter list +\fBfilters\fP (\fI\%list\fP <\fI\%str\fP>) – device name filter list .UNINDENT .TP .B Returns @@ -4793,9 +4793,9 @@ find aliases from fullnames .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) \-\- list of pool devices +\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) – list of pool devices .IP \(bu 2 -\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) \-\- fullnames if None returns all aliases +\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) – fullnames if None returns all aliases .UNINDENT .TP .B Returns @@ -4814,9 +4814,9 @@ provides channel sources .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) \-\- list of pool devices +\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) – list of pool devices .IP \(bu 2 -\fBdevices\fP (\fI\%list\fP <\fI\%str\fP>) \-\- alias names +\fBdevices\fP (\fI\%list\fP <\fI\%str\fP>) – alias names .UNINDENT .TP .B Returns @@ -4835,9 +4835,9 @@ provides device controller full names .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) \-\- list of pool devices +\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) – list of pool devices .IP \(bu 2 -\fBdevices\fP (\fI\%list\fP <\fI\%str\fP>) \-\- alias names +\fBdevices\fP (\fI\%list\fP <\fI\%str\fP>) – alias names .UNINDENT .TP .B Returns @@ -4856,11 +4856,11 @@ provides experimental Channels .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) \-\- list of pool devices +\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) – list of pool devices .IP \(bu 2 -\fBlistattr\fP (\fI\%str\fP) \-\- pool attribute with list +\fBlistattr\fP (\fI\%str\fP) – pool attribute with list .IP \(bu 2 -\fBtypefilter\fP (\fI\%list\fP <\fI\%str\fP>) \-\- pool attribute with list +\fBtypefilter\fP (\fI\%list\fP <\fI\%str\fP>) – pool attribute with list .UNINDENT .TP .B Returns @@ -4879,9 +4879,9 @@ find device names from aliases .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) \-\- list of pool devices +\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) – list of pool devices .IP \(bu 2 -\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) \-\- alias names if None returns name for all aliases +\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) – alias names if None returns name for all aliases .UNINDENT .TP .B Returns @@ -4900,9 +4900,9 @@ find measurement group name from alias .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) \-\- list of pool devices +\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) – list of pool devices .IP \(bu 2 -\fBalias\fP (\fI\%str\fP) \-\- mntgrp alias +\fBalias\fP (\fI\%str\fP) – mntgrp alias .UNINDENT .TP .B Returns @@ -4919,7 +4919,7 @@ find motor names .INDENT 7.0 .TP .B Parameters -\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) \-\- list of pool devices +\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) – list of pool devices .TP .B Returns full name of the measurement group alias @@ -4941,7 +4941,7 @@ provides datasource from pool device .INDENT 7.0 .TP .B Parameters -\fBname\fP (\fI\%str\fP) \-\- pool device name +\fBname\fP (\fI\%str\fP) – pool device name .TP .B Returns source of pool device @@ -4959,9 +4959,9 @@ provides tiemrs of given pools .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) \-\- list of pool devices +\fBpools\fP (\fI\%list\fP <\fI\%tango.DeviceProxy\fP>) – list of pool devices .IP \(bu 2 -\fBfilters\fP (\fI\%list\fP <\fI\%str\fP>) \-\- device name filter list +\fBfilters\fP (\fI\%list\fP <\fI\%str\fP>) – device name filter list .UNINDENT .TP .B Returns @@ -4987,11 +4987,11 @@ executes command on server on python package .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBserver\fP (\fI\%tango.DeviceProxy\fP or \fI\%nxsconfigserver.XMLConfigurator.XMLConfigurator\fP) \-\- tango server name or package name +\fBserver\fP (\fI\%tango.DeviceProxy\fP or \fI\%nxsconfigserver.XMLConfigurator.XMLConfigurator\fP) – tango server name or package name .IP \(bu 2 -\fBcommand\fP (\fI\%str\fP) \-\- command name +\fBcommand\fP (\fI\%str\fP) – command name .IP \(bu 2 -\fBvar\fP ([ \fIany\fP ]) \-\- command variable list +\fBvar\fP ([ \fIany\fP ]) – command variable list .UNINDENT .TP .B Returns @@ -5010,9 +5010,9 @@ finds device of give class .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdb\fP (\fI\%tango.DeviceProxy\fP) \-\- tango database +\fBdb\fP (\fI\%tango.DeviceProxy\fP) – tango database .IP \(bu 2 -\fBcname\fP (\fI\%str\fP) \-\- device class name +\fBcname\fP (\fI\%str\fP) – device class name .UNINDENT .TP .B Returns @@ -5031,9 +5031,9 @@ provides tango device full name with host and port .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBsource\fP (\fI\%str\fP) \-\- string with device name and its attribute +\fBsource\fP (\fI\%str\fP) – string with device name and its attribute .IP \(bu 2 -\fBfqdn\fP (\fI\%bool\fP) \-\- if true adds fqdn host name +\fBfqdn\fP (\fI\%bool\fP) – if true adds fqdn host name .UNINDENT .TP .B Returns @@ -5050,7 +5050,7 @@ provides proxies of given device names .INDENT 7.0 .TP .B Parameters -\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) \-\- given device names +\fBnames\fP (\fI\%list\fP <\fI\%str\fP>) – given device names .TP .B Returns list of device DeviceProxies @@ -5066,7 +5066,7 @@ retrives shape type units for attribure .INDENT 7.0 .TP .B Parameters -\fBsource\fP (\fI\%str\fP) \-\- string with device name and its attribute +\fBsource\fP (\fI\%str\fP) – string with device name and its attribute .TP .B Returns (shape, data_type, units) @@ -5082,7 +5082,7 @@ opens device proxy of the given device .INDENT 7.0 .TP .B Parameters -\fBdevice\fP (\fI\%str\fP) \-\- device name +\fBdevice\fP (\fI\%str\fP) – device name .TP .B Returns DeviceProxy of device @@ -5104,7 +5104,7 @@ waits for device proxy not running .INDENT 7.0 .TP .B Parameters -\fBproxy\fP (\fI\%tango.DeviceProxy\fP) \-\- device proxy +\fBproxy\fP (\fI\%tango.DeviceProxy\fP) – device proxy .TP .B Returns if proxy device ready @@ -5129,9 +5129,9 @@ copares two dictionaries .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBdct\fP (\fI\%dict\fP) \-\- first dictinary +\fBdct\fP (\fI\%dict\fP) – first dictinary .IP \(bu 2 -\fBdct2\fP (\fI\%dict\fP) \-\- second dictinary +\fBdct2\fP (\fI\%dict\fP) – second dictinary .UNINDENT .TP .B Returns @@ -5148,7 +5148,7 @@ provides datasource record from xml dom node .INDENT 7.0 .TP .B Parameters -\fBnode\fP (\fBlxml.etree.Element\fP) \-\- xml DOM node +\fBnode\fP (\fBlxml.etree.Element\fP) – xml DOM node .TP .B Returns datasource record @@ -5164,7 +5164,7 @@ collects text from text child nodes .INDENT 7.0 .TP .B Parameters -\fBnode\fP (\fI\%xml.etree.ElementTree.Element\fP) \-\- parent node +\fBnode\fP (\fI\%xml.etree.ElementTree.Element\fP) – parent node .UNINDENT .UNINDENT .INDENT 7.0 @@ -5185,9 +5185,9 @@ converts string to json dictionary .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBstring\fP (\fI\%str\fP) \-\- string with list of item or json dictionary +\fBstring\fP (\fI\%str\fP) – string with list of item or json dictionary .IP \(bu 2 -\fBtoBool\fP (\fI\%bool\fP) \-\- if true convert dictionary values to bool +\fBtoBool\fP (\fI\%bool\fP) – if true convert dictionary values to bool .UNINDENT .TP .B Returns @@ -5204,7 +5204,7 @@ converts string to json list .INDENT 7.0 .TP .B Parameters -\fBstring\fP (\fI\%str\fP) \-\- with list of item or json list +\fBstring\fP (\fI\%str\fP) – with list of item or json list .TP .B Returns json list @@ -5220,7 +5220,7 @@ converts list/dict/object of unicode/string to string object .INDENT 7.0 .TP .B Parameters -\fBobj\fP (\fIany\fP) \-\- given unicode/string object +\fBobj\fP (\fIany\fP) – given unicode/string object .TP .B Returns string object @@ -5249,7 +5249,7 @@ runs the TANGO server .INDENT 7.0 .TP .B Parameters -\fBargv\fP (\fI\%list\fP <\fI\%str\fP>) \-\- command\-line arguments +\fBargv\fP (\fI\%list\fP <\fI\%str\fP>) – command\-line arguments .UNINDENT .UNINDENT .INDENT 0.0 diff --git a/nxsrecconfig/DynamicComponent.py b/nxsrecconfig/DynamicComponent.py index 3ca1e01..283f764 100644 --- a/nxsrecconfig/DynamicComponent.py +++ b/nxsrecconfig/DynamicComponent.py @@ -247,6 +247,8 @@ def __createSardanaNodes(self, created, definition): :param definition: definition node :type definition: :class:`lxml.etree.Element` """ + special = ["strategy", "dtype", "name", "unit", "shape"] + for dd in self.__stepdsourcesDict: defaultpath = self.__defaultpath strategy = dd["strategy"] if "strategy" in dd else "STEP" @@ -266,9 +268,15 @@ def __createSardanaNodes(self, created, definition): created.append(alias) nxtype = self.__npTn[dd["dtype"]] \ if dd["dtype"] in self.__npTn.keys() else 'NX_CHAR' - self.__createField( + field = self.__createField( parent, field, nxtype, alias, dd["name"], dd["shape"], strategy=strategy, dstype='CLIENT') + if "unit" in dd: + field.attrib["units"] = str(dd["unit"]) + for ky, vl in dd.items(): + if ky not in special: + field.attrib[ky] = str(vl) + if link: self.__createLink(nxdata, path, field) @@ -505,6 +513,8 @@ def __createField(cls, parent, fname, nxtype, sname, :type strategy: :obj:`str` :param dstype: datasource type :type dstyp: :obj:`str` + :returns: etree xml field element + :rtype dstyp: :class:`lxml.etree.Element` """ field = lxml.etree.Element("field") parent.append(field) @@ -555,6 +565,7 @@ def __createField(cls, parent, fname, nxtype, sname, dm.append(dim) dim.attrib["index"] = Utils.tostr(i + 1) dim.attrib["value"] = Utils.tostr(shape[i]) + return field def remove(self, name): """ removes dynamic component diff --git a/nxsrecconfig/Release.py b/nxsrecconfig/Release.py index 57d866a..69d569d 100644 --- a/nxsrecconfig/Release.py +++ b/nxsrecconfig/Release.py @@ -20,4 +20,4 @@ """ NeXus Sardana Recorder Settings - Release """ #: (:obj:`str`) package version -__version__ = "3.37.0" +__version__ = "3.38.0"