How socone-chinguyen/dashboard_source works
Project type and purpose
• This is a C++-based dashboard library/tool that provides a REST-style API (using Oatpp) for ingesting simulation events from SilKit and exposing dashboard operations to client code. It comprises two main deliverables:
• A “Service” module that hosts an HTTP server, listens for SilKit simulation events, transforms them into DTOs, and exposes endpoints.
• A “Client” module that invokes those endpoints (create/update dashboards, instances, participants, etc.) and marshals/unmarshals the DTOs.
• IntegrationTests glue the client and service in a test harness.
File structure
• Top-level:
• CMakeLists.txt – build and dependency management.
• Client/ – client-side API client, command classes, mocks, and unit tests.
• Service/ – server-side event handlers, queues, mapper to Oatpp DTOs, mocks, and unit tests.
• Dto/ – shared data transfer object definitions used by both sides.
• IntegrationTests/ – end-to-end tests spinning up a fake server and a test client runner.
• OatppContext.* & OatppHeaders.* – bootstrap of the Oatpp web server and HTTP helpers.
README for additional insights
• The README is a placeholder (“# tesst”), so rely on file names and directory structure to infer architecture.
Elements
– Blue for Service components,
– Green for Client components,
– Yellow for shared DTOs,
– Gray for external dependencies and tests.
Detail
• Document data flows (Event → DTO → HTTP → Command → API call → Response).
• The goal is maximum clarity on who calls whom, who transforms what, and where tests/mock intercept.