`SignalIn`/`SignalOut` names are overloaded

Aperta
#582 8 commenti 2 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@superwhiskers ci sta già lavorando.

Dal 2/10/2026.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
cpp
Ambito
backend

Direzione di ricerca

Inizia esaminando le modifiche a SignalIn e SignalOut di #570 e cercando le relative definizioni e occorrenze, inclusi ComponentData, Port e PortGroup. Conferma con i partecipanti all’issue la distinzione prevista tra valori del segnale, nodi del segnale e porte. Il lavoro è completato quando uno schema di denominazione concordato viene applicato in modo coerente all’API interessata e ai relativi riferimenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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).

Lingua principale
C++
Stelle
27
Fork
11
Merge medio
2g 21h
PR unite (30g)
15

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ORNL/GridKit

Tutte le issue di ORNL/GridKit

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.