ChimeraTK / ChimeraTK/ControlSystemAdapter

Potentially confusing names.

Open
#39 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

redmine
Dominant language
C++
Stars
3
Forks
3
PR merge metrics
No merged PRs in 30d

Description

As I understand it, the ReferenceTestApplication creates a pair of linked process variables: FROM_DEVICE_XX, TO_DEVICE_XX. My intuition with this scheme is, data flows from the FROM to the TO variant.

However the code seems to invert this (looking at TypedPVHolder::inputToOutput); it takes data from the TO variant and writes it to the FROM variant. If there is no good reason for this behavior, please consider changing it to be inline with the concept of sending data from a source to a destination.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with ReferenceTestApplication and TypedPVHolder::inputToOutput, then trace how the FROM_DEVICE_XX and TO_DEVICE_XX process variables are linked. Confirm whether data is intentionally copied from TO to FROM; done means either documenting the rationale or aligning the names and behavior so the direction is unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend-api-design
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.