711ee1b40f
The god-class is gone. Each capability is now its own focused store:
StatusVariableStore, DataVariableStore, EquipmentConstantStore (with EAC
range validation), EventReportSubscriptions, AlarmRegistry, RecipeStore,
Clock, HostCommandRegistry. Each is independently testable.
EquipmentDataModel becomes a small composite that holds one of each store
as a public member, plus three convenience methods (vid_value, vid_exists,
compose_reports_for) that span SVIDs+DVIDs and inject the right callbacks
into the EventReportSubscriptions.
New under include/secsgem/gem/store/:
status_variables.hpp StatusVariable, StatusVariableStore,
DataVariable, DataVariableStore
equipment_constants.hpp EquipmentConstant, EquipmentConstantStore,
EquipmentAck. set_value() now validates
numeric values against min_str/max_str and
returns EAC=4 on out-of-range — closes the
COMPLIANCE.md gap about EC range validation.
event_reports.hpp CollectionEvent, Report, ReportData,
EventReportSubscriptions + DefineReportAck,
LinkEventAck, EnableEventAck. The store is
pure data; VidLookup / VidExists callbacks
are injected at define / emit time so the
service doesn't back-reference the SVID
store.
alarms.hpp Alarm, AlarmAck, AlarmRegistry.
Encapsulates the (enabled, active) sets and
ALCD byte computation.
recipes.hpp ProcessProgramAck, RecipeStore.
clock.hpp TimeAck, Clock. set_time_string applies an
offset so subsequent reads reflect the host
time without mutating system clock.
host_commands.hpp HostCmdAck, CommandParameter,
HostCommandRegistry with Spec/Result types.
include/secsgem/gem/data_model.hpp shrinks to a 50-line composite:
struct EquipmentDataModel {
StatusVariableStore svids;
DataVariableStore dvids;
EquipmentConstantStore ecids;
EventReportSubscriptions events;
AlarmRegistry alarms;
RecipeStore recipes;
Clock clock;
HostCommandRegistry commands;
/* + vid_value, vid_exists, compose_reports_for sugar */
};
src/gem/data_model.cpp is gone — every store is inline header-only.
include/secsgem/gem/messages_helpers.hpp picks up EventReportAck and
TerminalAck (S6F12 / S10F2-F4 ack enums that aren't tied to any one
store).
Call-site updates:
apps/secs_server.cpp model->status_variable(id) -> model->svids.get(id),
model->equipment_constant(id) -> model->ecids.get(id),
model->alarm_set(id) -> model->alarms.set_active(id),
model->dispatch_command(...) -> model->commands.dispatch(...),
and similar across every handler. Plus
model->current_time_string() -> model->clock....
src/config/loader.cpp model.add_status_variable(sv) -> model.svids.add(sv),
and similar. HostCommandRegistry::Spec replaces
EquipmentDataModel::CommandSpec.
apps/secs_client.cpp std::vector<EquipmentDataModel::CommandParam> ->
std::vector<CommandParameter>.
tests/test_data_model.cpp Rewritten around the individual stores;
each gets its own TEST_CASE block. Adds three
new cases covering EC range validation (in
range / out of range / non-numeric skipped).
tests/test_loader.cpp m.has_event(100) -> m.events.has_event(100),
etc.
Verified:
- Tests: 69 cases / 370 assertions pass (was 67 / 384; -14 stale
composite-API assertions + 16 new store-level assertions covering
EC range validation and the per-store add/get/list/delete paths).
- Demo: byte-identical behaviour across the full 17-step flow.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
144 lines
5.6 KiB
C++
144 lines
5.6 KiB
C++
#pragma once
|
|
|
|
#include <cstdint>
|
|
#include <functional>
|
|
#include <optional>
|
|
#include <string>
|
|
#include <variant>
|
|
#include <vector>
|
|
|
|
#include "secsgem/gem/data_model.hpp"
|
|
#include "secsgem/secs2/item.hpp"
|
|
#include "secsgem/secs2/message.hpp"
|
|
|
|
// Hand-written helpers used by the generated messages.hpp: scalar accessors
|
|
// (one per SECS-II type), a few list helpers, and the two special-case
|
|
// messages whose shape doesn't fit the codegen schema (S1F4 needs per-row
|
|
// optional values; S5F6 needs a callback to compute ALCD per alarm).
|
|
|
|
namespace secsgem::gem {
|
|
|
|
namespace s2 = secsgem::secs2;
|
|
namespace secs2 = secsgem::secs2; // alias used by generated code
|
|
|
|
// ---- Scalar accessors ----------------------------------------------------
|
|
|
|
inline std::optional<std::string> as_ascii(const s2::Item& item) {
|
|
if (item.format() != s2::Format::ASCII) return std::nullopt;
|
|
return item.as_ascii();
|
|
}
|
|
|
|
inline std::optional<std::string> as_binary_string(const s2::Item& item) {
|
|
if (item.format() != s2::Format::Binary) return std::nullopt;
|
|
const auto& v = item.as_bytes();
|
|
return std::string(v.begin(), v.end());
|
|
}
|
|
|
|
inline std::optional<uint8_t> as_binary_first(const s2::Item& item) {
|
|
if (item.format() != s2::Format::Binary) return std::nullopt;
|
|
const auto& v = item.as_bytes();
|
|
if (v.empty()) return std::nullopt;
|
|
return v.front();
|
|
}
|
|
|
|
inline std::optional<bool> as_boolean(const s2::Item& item) {
|
|
if (item.format() != s2::Format::Boolean) return std::nullopt;
|
|
const auto& v = item.as_bytes();
|
|
if (v.empty()) return std::nullopt;
|
|
return v.front() != 0;
|
|
}
|
|
|
|
// Templated typed-scalar accessor — one specialization per SECS-II numeric.
|
|
template <typename Vec>
|
|
inline std::optional<typename Vec::value_type> first_or_none(const s2::Item& item,
|
|
s2::Format want) {
|
|
if (item.format() != want) return std::nullopt;
|
|
const auto& v = std::get<Vec>(item.storage());
|
|
if (v.empty()) return std::nullopt;
|
|
return v.front();
|
|
}
|
|
|
|
inline std::optional<uint8_t> as_u1_scalar(const s2::Item& i) { return first_or_none<std::vector<uint8_t>>(i, s2::Format::U1); }
|
|
inline std::optional<uint16_t> as_u2_scalar(const s2::Item& i) { return first_or_none<std::vector<uint16_t>>(i, s2::Format::U2); }
|
|
inline std::optional<uint32_t> as_u4_scalar(const s2::Item& i) { return first_or_none<std::vector<uint32_t>>(i, s2::Format::U4); }
|
|
inline std::optional<uint64_t> as_u8_scalar(const s2::Item& i) { return first_or_none<std::vector<uint64_t>>(i, s2::Format::U8); }
|
|
inline std::optional<int8_t> as_i1_scalar(const s2::Item& i) { return first_or_none<std::vector<int8_t>>(i, s2::Format::I1); }
|
|
inline std::optional<int16_t> as_i2_scalar(const s2::Item& i) { return first_or_none<std::vector<int16_t>>(i, s2::Format::I2); }
|
|
inline std::optional<int32_t> as_i4_scalar(const s2::Item& i) { return first_or_none<std::vector<int32_t>>(i, s2::Format::I4); }
|
|
inline std::optional<int64_t> as_i8_scalar(const s2::Item& i) { return first_or_none<std::vector<int64_t>>(i, s2::Format::I8); }
|
|
inline std::optional<float> as_f4_scalar(const s2::Item& i) { return first_or_none<std::vector<float>>(i, s2::Format::F4); }
|
|
inline std::optional<double> as_f8_scalar(const s2::Item& i) { return first_or_none<std::vector<double>>(i, s2::Format::F8); }
|
|
|
|
// ---- List helpers --------------------------------------------------------
|
|
|
|
inline s2::Item u4_list_item(const std::vector<uint32_t>& ids) {
|
|
s2::Item::List children;
|
|
children.reserve(ids.size());
|
|
for (auto id : ids) children.push_back(s2::Item::u4(id));
|
|
return s2::Item::list(std::move(children));
|
|
}
|
|
|
|
inline std::optional<std::vector<uint32_t>> parse_u4_list_body(const s2::Message& m) {
|
|
if (!m.body || !m.body->is_list()) return std::nullopt;
|
|
std::vector<uint32_t> out;
|
|
for (const auto& c : m.body->as_list()) {
|
|
auto v = as_u4_scalar(c);
|
|
if (!v) return std::nullopt;
|
|
out.push_back(*v);
|
|
}
|
|
return out;
|
|
}
|
|
|
|
// Generic "body is <B ack>" reader, used by tests + apps as a quick helper.
|
|
inline std::optional<uint8_t> ack_byte(const s2::Message& m) {
|
|
if (!m.body) return std::nullopt;
|
|
return as_binary_first(*m.body);
|
|
}
|
|
|
|
// ---- S1F4: list of values, nullopt -> <L,0> -----------------------------
|
|
|
|
inline s2::Message s1f4_selected_status_data(
|
|
const std::vector<std::optional<s2::Item>>& values) {
|
|
s2::Item::List children;
|
|
children.reserve(values.size());
|
|
for (const auto& v : values) {
|
|
children.push_back(v ? *v : s2::Item::list({}));
|
|
}
|
|
return s2::Message(1, 4, false, s2::Item::list(std::move(children)));
|
|
}
|
|
|
|
// ---- S5F6: alarm directory; ALCD bit-7 from per-row callback ------------
|
|
|
|
inline s2::Message s5f6_list_alarms_data(const std::vector<Alarm>& alarms,
|
|
const std::function<bool(uint32_t)>& active) {
|
|
s2::Item::List rows;
|
|
rows.reserve(alarms.size());
|
|
for (const auto& a : alarms) {
|
|
const uint8_t alcd = (a.severity_category & 0x7F) |
|
|
static_cast<uint8_t>(active(a.id) ? 0x80 : 0x00);
|
|
rows.push_back(s2::Item::list(
|
|
{s2::Item::binary({alcd}), s2::Item::u4(a.id), s2::Item::ascii(a.text)}));
|
|
}
|
|
return s2::Message(5, 6, false, s2::Item::list(std::move(rows)));
|
|
}
|
|
|
|
// ---- ALED byte constants for S5F3 ---------------------------------------
|
|
|
|
inline constexpr uint8_t kAlarmEnableByte = 0x80;
|
|
inline constexpr uint8_t kAlarmDisableByte = 0x00;
|
|
|
|
// ---- Ack enums that aren't tied to a specific store -------------------
|
|
|
|
enum class EventReportAck : uint8_t { // S6F12
|
|
Accept = 0,
|
|
Denied = 1,
|
|
};
|
|
|
|
enum class TerminalAck : uint8_t { // S10F2, S10F4
|
|
Accepted = 0,
|
|
WillNotDisplay = 1,
|
|
TerminalNotAvailable = 2,
|
|
};
|
|
|
|
} // namespace secsgem::gem
|