Skip to content

Commit 545bfac

Browse files
authored
docs(vendor-neutral): remove commercial identifiers from explanatory source and test comments (#309)
Vendor-neutral IEC 61850 source and test documentation comments
2 parents 3939b59 + 2a32bd0 commit 545bfac

10 files changed

Lines changed: 14 additions & 14 deletions

‎include/ariec61850/mms/services_span.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ class MmsServiceSpanCodec final {
141141
static constexpr std::size_t maximum_identifiers = 128U;
142142

143143
// reference IEC 61850 client performs bounded bulk reads while walking a full IEC 61850 model.
144-
// The proven ARIEC61850 trace for the SIPROTEC reference model contains a
144+
// The proven ARIEC61850 trace for the reference IEC 61850 model contains a
145145
// single 78-variable Read request. Keep the portable span profile bounded,
146146
// but leave enough headroom for that real discovery pattern.
147147
static constexpr std::size_t maximum_variables = 128U;

‎include/ariec61850/mms/simulator_manifest_codec.hpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ class MmsSimulatorManifestCodec final {
6969
return result;
7070
}
7171
if (raw == "ENUM") {
72-
// OMICRON reference IEC 61850 client advertises IEC 61850 Enum leaves as INTEGER(8)
73-
// for the captured SIPROTEC model (Mod/Beh/Health/ctlModel).
72+
// independent IEC 61850 test client advertises IEC 61850 Enum leaves as INTEGER(8)
73+
// for the captured reference IED model (Mod/Beh/Health/ctlModel).
7474
result.kind = MmsTypeKind::integer;
7575
result.size = 8U;
7676
return result;

‎src/mms/services.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ std::vector<std::uint8_t> encode_type_impl(
197197
}
198198
auto encoded = BerWriter::encode_signed_integer(
199199
-static_cast<std::int64_t>(*type.size));
200-
// OMICRON reference IEC 61850 client emits variable maximum lengths in at least a
200+
// independent IEC 61850 test client emits variable maximum lengths in at least a
201201
// two-octet signed field. In the golden capture Octet64 is
202202
// 89 02 FF C0 (not the mathematically minimal 89 01 C0).
203203
if (encoded.size() == 1U) encoded.insert(encoded.begin(), 0xFFU);

‎src/mms/static_direct_control.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ void release_selection(MmsStaticDirectBooleanControlBinding& binding) noexcept {
235235
const MmsStaticDirectBooleanOperate& right,
236236
const bool compare_check) noexcept {
237237
// IEC 61850 enhanced SBO correlation is based on the selected command
238-
// identity. OMICRON reference IEC 61850 client emits a fresh T for Oper (and may do so for
238+
// identity. independent IEC 61850 test client emits a fresh T for Oper (and may do so for
239239
// Cancel) rather than replaying the SBOw timestamp, so T is intentionally
240240
// not part of selection identity. The accepted Oper itself is still kept
241241
// intact for CommandTermination correlation.
@@ -261,7 +261,7 @@ void release_selection(MmsStaticDirectBooleanControlBinding& binding) noexcept {
261261
const MmsStaticDirectBooleanControlBinding& binding,
262262
const MmsStaticDirectBooleanOperate& command) noexcept {
263263
// ctlNum is an IEC 61850 wire value supplied by the remote client. Keep
264-
// zero valid on the server path: OMICRON reference IEC 61850 client uses ctlNum=0 in real
264+
// zero valid on the server path: independent IEC 61850 test client uses ctlNum=0 in real
265265
// SBOw/Oper traffic. ARStack's client-side auto-allocation policy (1..255)
266266
// is separate and remains unchanged.
267267
return command.origin_category <= 8U &&

‎src/mms/static_dispatcher.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -636,7 +636,7 @@ struct SyntheticChildRank final {
636636
if (prefix.find("$BR$") != std::string_view::npos) {
637637
return {kBrcbAttributeOrder};
638638
}
639-
// OMICRON reference IEC 61850 client exposes control-service alternatives in this exact
639+
// independent IEC 61850 test client exposes control-service alternatives in this exact
640640
// order at LN$CO$DO. Deeper service structures remain positional.
641641
if (prefix.find("$CO$") != std::string_view::npos &&
642642
static_cast<std::size_t>(std::count(

‎src/simulation/ied_simulator_profile.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ namespace {
195195
// q/t are semantic terminal DataAttribute names, not arbitrary suffixes.
196196
// The former ends_with("t") rule misclassified orCat, orIdent,
197197
// sboTimeout, operTimeout and Test as Timestamp, corrupting the live MMS
198-
// TypeSpecification seen by OMICRON reference IEC 61850 client.
198+
// TypeSpecification seen by independent IEC 61850 test client.
199199
if (entry.is_quality || attribute_leaf_is(entry.da_name, "q") ||
200200
ascii_equal(entry.basic_type, "Quality")) {
201201
return "Quality";

‎tests/test_mms_static_direct_control.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ void invalid_shape_and_values_are_rejected() {
197197
CHECK(!result.success);
198198
CHECK(result.failure_code == 7U);
199199

200-
// ctlNum=0 is valid on the incoming server wire. OMICRON reference IEC 61850 client uses it.
200+
// ctlNum=0 is valid on the incoming server wire. independent IEC 61850 test client uses it.
201201
result = mms_static_direct_boolean_write_oper(&binding, make_oper(true, 0U, false));
202202
CHECK(result.success);
203203
CHECK(state.last_control_number == 0U);
@@ -329,7 +329,7 @@ void reference_iec61850_sbo_enhanced_accepts_ctl_num_zero_and_fresh_oper_timesta
329329
binding.policy.allow_synchro_check = true;
330330
binding.policy.allow_interlock_check = true;
331331

332-
// Captured OMICRON reference IEC 61850 client behavior:
332+
// Captured independent IEC 61850 test client behavior:
333333
// SBOw uses ctlNum=0 and T1; Oper keeps the selected identity but sends T2.
334334
const auto selected = mms_static_boolean_write_sbow_contextual(
335335
&binding,

‎tools/static_ied_server_iedsim/test_cswi1_type_golden.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/usr/bin/env python3
2-
"""Exact OMICRON reference IEC 61850 client CSWI1 TypeSpecification golden regression."""
2+
"""Exact independent IEC 61850 test client CSWI1 TypeSpecification golden regression."""
33

44
from __future__ import annotations
55

@@ -29,7 +29,7 @@ def manifest() -> str:
2929
"ARSTACK_IED_MODEL\t2\t1",
3030
f"LN\t{d}\tCSWI1",
3131

32-
# ST — exact leaf order/type shape captured from OMICRON reference IEC 61850 client.
32+
# ST — exact leaf order/type shape captured from independent IEC 61850 test client.
3333
f"OBJ\t{d}\tCSWI1$ST$Mod$stVal\tENUM\tEnumeration\t1",
3434
f"OBJ\t{d}\tCSWI1$ST$Mod$q\tQUALITY\tQuality\tgood",
3535
f"OBJ\t{d}\tCSWI1$ST$Mod$t\tTimestamp\tTimestamp\tunix-ms:1720000000000",

‎tools/static_ied_server_iedsim/test_reporting_golden.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ int main() {
300300
return 14;
301301
}
302302

303-
// The accepted OMICRON command capture produced a selective BRCB report
303+
// The accepted independent test-client capture produced a selective BRCB report
304304
// after process feedback. Its 36-bit inclusion field selects member 33 and
305305
// ReasonForInclusion is data-change. Lock SqNum/EntryID progression too.
306306
constexpr std::size_t changed_member = 33U;

‎tools/static_ied_server_iedsim/test_runtime_model.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def creation_flags() -> int:
2626
def manifest(revision: int, value: bool) -> str:
2727
"""Build a vendor-style model with configured whole-DO DataSet members.
2828
29-
The 36/22 cardinalities mirror the SIPROTEC acceptance case that exposed the
29+
The 36/22 cardinalities mirror the reference IED acceptance case that exposed the
3030
regression. Each configured member owns multiple leaves, so flattening the
3131
Digital DataSet would exceed the 64-member static DataSet limit while the
3232
correct configured membership remains safely at 36.

0 commit comments

Comments
 (0)