Private
Public Access
11
1

formatting PixelatorControllerSettings

2022-10-04 16:35:04 +02:00
parent 87d804fc18
commit 0ec8b4e059

@@ -201,30 +201,31 @@ See source:trunk/PixelatorController/config/instrument.json for an example.
### NeXus class
Every top level entry may have a "class" member that is used as the NeXus class of the group.
Without the "class" member, the NeXus class of the group is built using the groups name: "NX" + lower(name) \\
Without the "class" member, the NeXus class of the group is built using the groups name: "NX" + lower(name)
Values can be
* strings
* numbers
* [#positionerValues positioner values]
* [positioner values](#positioner-values)
* arrays of numbers or [positioner values](#positioner-values)
* [#unitValues value with unit]
* objects \\
a nested NeXus group is created \\
these nested objects must have a "class" member
* [value with unit](#value-with-unit)
* objects:
* a nested NeXus group is created
* these nested objects must have a "class" member
### Conditional Writing
A group may be written conditionally. When a settings object has a "condition" member, its value defines a condition
that must be met in order to write the entire group. The value of the condition has the form:
{{{ {"operator" : [values]} }}}
that must be met in order to write the entire group. The value of the condition has the form:<BR>
`{"operator" : [values]}`
values can be
* strings
* numbers
* [positioner values](#positioner-values)
* [#epicsChannelValues epics channel values]
* [epics channel values](#epics-channel-values )
Only one operator is implemented so far:
* {{{ {"==" : [value1, value2]} }}}
Only one operator is implemented so far:<BR>
`{"==" : [value1, value2]}`
### Positioner Values
To write the (numeric) value of a positioner to the NXinstrument section or to use it in a [condition](#conditional-writing),
@@ -240,11 +241,13 @@ a value can be a json object with the following member:
### Value with Unit
As all numeric values should be written with a unit,
a value can be a json object with value and unit:
{{{ {"value" : value, "unit" : unit} }}}
a value can be a json object with value and unit:<BR>
`{"value" : value, "unit" : unit}`
value can be
* numbers
* arrays of numbers
unit must be a string
## Log4cpp Properties
@@ -279,8 +282,7 @@ See source:trunk/PixelatorController/config/pixelClock.json for an example.
&emsp;**Default***: 0.005
**waitUntilDoneTimeout**::<BR>
&emsp;Double value defines the timeout (in seconds) used in waitUntilDone().
running() is called until it returns false or until waitUntilDoneTimeout is exceeded.<BR>
&emsp;Double value defines the timeout (in seconds) used in waitUntilDone(). running() is called until it returns false or until waitUntilDoneTimeout is exceeded.<BR>
&emsp;**Default**: 10.0
## Polarization
@@ -375,13 +377,13 @@ The following settings are available for all types of positioners:
&emsp;"Manual" : Positioner remains powered after scanning moves, but is unpowered by "All Motors Off" request.<BR>
&emsp;**Default**: "Never"
| autoOff value | direct | scan | "All Motors Off" |
|---------------|--------|------|------------------|
| "Never" | ON | ON | ON |
| "Always" | OFF | OFF | OFF |
| "SlowAxis" | OFF | ON* | OFF |
| "Disabled" | -- | -- | -- |
| "Manual" | ON | ON | OFF |
| autoOff value | direct | scan<BR>(fastest axis) | scan<BR>(not fastest) | "All Motors Off" |
|---------------|--------|------|------|------------------|
| "Never" | ON | ON | ON | ON |
| "Always" | OFF | OFF | OFF | OFF |
| "SlowAxis" | OFF | ON | OFF | OFF |
| "Disabled" | -- | -- | -- | -- |
| "Manual" | ON | ON | ON | OFF |
**beamlineControlPosition**::<BR>
@@ -401,12 +403,12 @@ The following settings are available for all types of positioners:
**atPositionCheckTimeout**::<BR>
&emsp;Double value defines the timeout (in seconds) used in waitDoneMoving().
getStatus() is called as long as it returns moving or until atPositionCheckTimeout is exceeded. <BR>
&emsp;**Default''': atPositionCheckTimeout_Default (see above)
&emsp;**Default**: atPositionCheckTimeout_Default (see above)
stringPositions::
Optional array of objects with members
* '''string''': String value defines the position name
* '''position''': Double value defines the position value
**stringPositions**::<BR>
&emsp;Optional array of objects with members
* **string**: String value defines the position name
* **position**: Double value defines the position value
These objects can be used to get
* a name of a position value (positionUserToStringHardware)
@@ -417,17 +419,16 @@ This file contains the topup settings.
See source:trunk/PixelatorController/config/topup.json for an example.
active::
Integer value 1 activates topup handling. \\
'''Default''': 0
**active**::<BR>
&emsp;Integer value 1 activates topup handling. <BR>
&emsp;**Default**: 0
channel::
String value defines the EPICS address of the topup channel. \\
Mandatory for topup handling.
**channel**::<BR>
&emsp;String value defines the EPICS address of the topup channel. <BR>
&emsp;Mandatory for topup handling.
wait_time::
Float value defines the delay (in seconds) between when the topup signal stops and when stxm measurements resume. \\
See ticket #382. \\
'''Default''': 0
**wait_time**::<BR>
&emsp;Float value defines the delay (in seconds) between when the topup signal stops and when stxm measurements resume.<BR>
&emsp;**Default**: 0
## Zone Plate