ChimeraTK / ChimeraTK/DeviceAccess
LogicalNameMapping: Add plugin to set descriptions and engineering units
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 12
- Forks
- 12
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 13
Description
Depends on #42
When applying conversion formulas (for instance) the logical name mapping can change the engineering unit of a variable. In addition, it is useful to set units for variables created in the logical name mapping or that have none in the map file.
Definition of done:
- There is a plugin to set the EGU of a variable
- Test that the EGU can be set if there is none, and changed if there is one in the map file
- There is a plugin to set variable descriptions
- Test that the descriptions can be set if there is none, or overwritten of there is one in the map file
- Both features are documented in Doxygen
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by resolving dependency #42 and locating the logical name mapping plugin extension points in the DeviceAccess repository. Review how engineering units and descriptions are represented in the map file, then add tests for setting and overwriting both fields and document both features in Doxygen.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100