Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
HowToCpp
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Karabo
HowToCpp
Commits
ea4a07eb
Commit
ea4a07eb
authored
6 years ago
by
Cyril Danilevski
Browse files
Options
Downloads
Patches
Plain Diff
Add DAQ Policy documentation
parent
1246e3ae
No related branches found
No related tags found
1 merge request
!3
Add DAQ Policy documentation
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
source/daq_policy.rst
+39
-0
39 additions, 0 deletions
source/daq_policy.rst
source/images/daq_policy.png
+0
-0
0 additions, 0 deletions
source/images/daq_policy.png
with
39 additions
and
0 deletions
source/daq_policy.rst
0 → 100644
+
39
−
0
View file @
ea4a07eb
DAQ Policy
==========
Not every parameter of a device is interesting to record, such as the provided scenes.
As such, the policy for each individual property can be set, on a per-instance basis.
These are specified using the :class:`DAQPolicy` enum:
- `OMIT`: will not record the property to file;
- `SAVE`: will record the property to file;
- `UNSPECIFIED`: will adopt the global default DAQ policy. Currently, it is set to
record, although this will eventually change to not recorded.
Legacy devices which do not specify a policy will have an `UNSPECIFIED` policy set
to all their properties.
.. note::
This are applied to leaf properties. Nodes do not have DAQPolicy.
Developers should liaise with users to define which properties should be recorded.
These can be set up programmatically:
.. code-block:: c++
using namespace karabo::util;
void MyDevice::expectedParameters(karabo::util::Schema& expected) {
UINT32_ELEMENT(expected).key('enzymAssay')
.displayedName("Assay")
.description("Enzym Activity")
.unit(Unit::KATAL)
.metricPrefix(MetricPrefix::MICRO)
.daqPolicy(DAQPolicy::SAVE)
.readOnly().initialValue(0)
.commit();
}
The policy can be overwritten from the GUI, before instantiation, and saved in a project:
.. image:: graphics/daq_policy.png
This diff is collapsed.
Click to expand it.
source/images/daq_policy.png
0 → 100644
+
0
−
0
View file @
ea4a07eb
14.4 KiB
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment