docs(délestage): documenter DrawCap — le garde-fou avait raison
Trois membres de DrawCap n'étaient pas documentés (DoD §5) : source, bornePhase() et borneTotal(). ci-quality les a signalés ; je les ai vus APRÈS avoir commité et poussé, en ayant lancé le contrôle dans une commande où son verdict passait sous la sortie du push. Le contrôle a fait son travail, pas moi : je l'ai regardé trop tard. C'est exactement l'écart que la section « ce qui tient et ce qui s'érode » décrit — la machine rejouait bien la règle, c'est la lecture du résultat qui a manqué. La documentation ajoutée dit aussi la règle du signe, qui n'était écrite que dans l'invariant de la structure : une valeur négative signifie « ce plafond ne borne pas de cette façon », jamais « zéro watt autorisé » — zéro est une valeur licite et voudrait dire interdiction totale de soutirer. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015F7G5VeaPVSMeVNjiGj36p
This commit is contained in:
parent
fa3c8d4755
commit
e1c1030d6f
@ -46,13 +46,17 @@ enum class DrawCapSource {
|
|||||||
* valeur licite et voudrait dire *interdiction totale de soutirer*.
|
* valeur licite et voudrait dire *interdiction totale de soutirer*.
|
||||||
*/
|
*/
|
||||||
struct DrawCap {
|
struct DrawCap {
|
||||||
|
//! D'où vient ce plafond. Décide du motif publié et du geste qu'il appelle.
|
||||||
DrawCapSource source = DrawCapSource::Breaker;
|
DrawCapSource source = DrawCapSource::Breaker;
|
||||||
//! Plafond **par phase**, en watts. Négatif = ce plafond ne borne pas par phase.
|
//! Plafond **par phase**, en watts. Négatif = ce plafond ne borne pas par phase.
|
||||||
double perPhaseW = -1;
|
double perPhaseW = -1;
|
||||||
//! Plafond **total** au point de livraison, en watts. Négatif = ne borne pas au total.
|
//! Plafond **total** au point de livraison, en watts. Négatif = ne borne pas au total.
|
||||||
double totalW = -1;
|
double totalW = -1;
|
||||||
|
|
||||||
|
//! \return Vrai si ce plafond borne PAR PHASE. Une valeur négative dit « pas de cette
|
||||||
|
//! façon » ; zéro dirait « zéro watt autorisé », ce qui est une autre affirmation.
|
||||||
bool bornePhase() const { return perPhaseW >= 0; }
|
bool bornePhase() const { return perPhaseW >= 0; }
|
||||||
|
//! \return Vrai si ce plafond borne AU TOTAL, au point de livraison. Même règle du signe.
|
||||||
bool borneTotal() const { return totalW >= 0; }
|
bool borneTotal() const { return totalW >= 0; }
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user