`SignalIn`/`SignalOut` names are overloaded

未关闭
#582 8 条评论 2 个 reaction 已指派 1 人 在 GitHub 查看

维护者通常 1 天内回复

@superwhiskers 已经在做这个了。

开始于 2026年10月2日。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
cpp
领域
backend

调研方向

首先查看 #570 中 SignalIn 和 SignalOut 的更改,并搜索它们的定义和用法,包括 ComponentData、Port 和 PortGroup。与 issue 参与者确认信号值、信号节点和端口之间预期的区别。完成的标准是在受影响的 API 及其引用中一致地应用一套达成共识的命名方案。

由索引模型根据 Issue 内容生成。

描述

question

@superwhiskers, @lukelowry, @abirchfield, @pelesh, @nkoukpaizan

TL;DR: The new SignalIn and SignalOut classes introduce some terminology confusion and should be renamed.

I failed to point this out before #570 was merged (great work on that, btw @superwhiskers).

This overloading of the terminology was part of the motivation behind the re-design. Based on multiple conversations leading to that design, my understanding was that there were three separate concepts all being referred to as "signals"...

  • the actual "signal" (the value)
  • the "signal node" carrying the signal
  • the "port" by which a component sends or receives the signal
    ... and that we wanted to distinguish between those concepts, especially because they are all used together in the same context.

Since the terms SignalIn and SignalOut refer to the variable values that are communicated over signal nodes (and are in fact already used with that meaning in ComponentData), it doesn't make sense to use those names to refer to the "port" classes that receive/send those values.

I originally used simply InputPort and OutputPort. If the name itself needs to communicate that these are used exclusively for "signal" communication, it could be SignalInputPort and SignalOutputPort (but in that case we might also want to rename Port and PortGroup for consistency).

主要语言
C++
星标
27
派生
11
平均合并
2 天 21 小时
30 天内合并 PR
15

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ORNL/GridKit 的其他 Issue

查看 ORNL/GridKit 的全部 Issue

相似的 Issue

更多 C++ Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。