Diagnostics
PipelineReport, debug probes, and observability helpers. More...
Classes Index
| class | ExecutionPlan |
|
Execution plan of one Model build, laid out as the graph it runs. More... | |
| struct | VerboseOptions |
|
Per-topic framework verbosity controls. More... | |
| struct | ValidateOptions |
|
Options for Graph::validate(). More... | |
| struct | PullError |
|
Structured error returned by Run::pull() when status is Error. More... | |
| struct | BusMessage |
|
A single GStreamer bus message captured during pipeline build/run. More... | |
| struct | BoundaryFlowStats |
|
Per-boundary flow statistics — buffer counts at identity probes between Nodes. More... | |
| struct | NodeReport |
|
Per-Node entry in the report, listing what that Node produced in the GStreamer pipeline. More... | |
| struct | BuildAdaptationAction |
|
One line item from the build-adaptation log. More... | |
| struct | BuildAdaptationSummary |
|
Snapshot of build-time adaptation state — present for build(input) flows. More... | |
| struct | GraphReport |
|
Structured pipeline diagnostics — the framework's primary triage record. More... | |
| class | NeatError |
|
Framework exception type carrying a structured GraphReport. More... | |
| struct | PowerRailConfig |
|
One board power rail. More... | |
| struct | PowerFieldReading |
|
One scalar rail reading. More... | |
| struct | PowerRailReading |
|
Snapshot for one rail. More... | |
| struct | PowerSnapshot |
|
Point-in-time board power snapshot. More... | |
| struct | PowerMonitorOptions |
|
Options for a PowerMonitor. More... | |
| struct | PowerFieldSummary |
|
Summary statistics for one scalar rail field. More... | |
| struct | PowerRailSummary |
|
Summary statistics for one rail. More... | |
| struct | PowerSummary |
|
Aggregated power monitor result. More... | |
| class | PowerMonitor |
|
Collects Sentinel power samples over a measured interval. More... | |
| struct | InputDropInfo |
|
Diagnostic record for a dropped input frame. More... | |
| struct | TelemetryStats |
|
One Sentinel measurement summarized over a telemetry window. More... | |
| struct | Telemetry |
|
Board telemetry Sentinel recorded during a window. More... | |
| class | TelemetryMonitor |
|
Records board telemetry from Sentinel between start() and stop(). More... | |
Enumerations Index
| enum class | VerbosityLevel { ... } |
|
Coarse-grained framework verbosity selector. More... | |
| enum class | PowerMonitorProfile { ... } |
|
Named board-level power monitor profiles. More... | |
Functions Index
| std::vector< PowerRailConfig > | default_modalix_som_power_rails () |
|
Default Modalix SOM PMIC rail table from the board measurement scripts. More... | |
| std::vector< PowerRailConfig > | default_modalix_dvt_power_rails () |
|
Default Modalix DVT PMIC rail table. More... | |
| PowerMonitorProfile | detect_default_power_monitor_profile () |
|
Detect the most likely built-in board power profile for the current host. More... | |
| std::string | power_monitor_profile_name (PowerMonitorProfile profile) |
|
Human-readable name for a power monitor profile. More... | |
| std::vector< PowerRailConfig > | power_rails_for_profile (PowerMonitorProfile profile) |
|
Resolve a built-in board profile to its rail table. More... | |
| PowerMonitorOptions | board_power_monitor_options (int sample_interval_ms=100, PowerMonitorProfile profile=PowerMonitorProfile::Auto) |
|
Options that enable board power monitoring. More... | |
| PowerMonitorOptions | modalix_som_power_monitor_options (int sample_interval_ms=100) |
|
Convenience options enabling Modalix SOM power monitoring. More... | |
| PowerMonitorOptions | modalix_dvt_power_monitor_options (int sample_interval_ms=100) |
|
Convenience options enabling Modalix DVT power monitoring. More... | |
| PowerSnapshot | read_power_snapshot (const PowerMonitorOptions &options) |
|
Read Sentinel's latest power sample. More... | |
| std::string | format_power_summary (const PowerSummary &summary) |
|
Format a compact human-readable power summary. More... | |
| std::string | power_summary_to_json (const PowerSummary &summary, int indent=2) |
|
Format power summary as a JSON object. More... | |
Description
PipelineReport, debug probes, and observability helpers.
Enumerations
PowerMonitorProfile
| strong |
Named board-level power monitor profiles.
- Enumeration values
- Deprecated
-
Ignored: Sentinel reports the rails of the running board.
Definition at line 32 of file PowerTelemetry.h.
VerbosityLevel
| strong |
Coarse-grained framework verbosity selector.
- Enumeration values
-
Quiet Suppress topic-specific messages; progress is controlled separately Production Concise phase updates suitable for end users Verbose Rich human-facing diagnostics across all framework topics
Combined with the per-topic flags in VerboseOptions to decide what diagnostic output the framework emits at runtime. Most users pick one of the three preset factories on VerboseOptions (quiet(), production(), debug_all()) rather than setting flags by hand.
Definition at line 88 of file GraphOptions.h.
Functions
board_power_monitor_options()
|
Options that enable board power monitoring.
Both arguments are deprecated and ignored.
- Deprecated
-
Use TelemetryMonitor.
Definition at line 186 of file PowerTelemetry.h.
default_modalix_dvt_power_rails()
|
Default Modalix DVT PMIC rail table.
Definition at line 155 of file PowerTelemetry.h.
default_modalix_som_power_rails()
|
Default Modalix SOM PMIC rail table from the board measurement scripts.
Definition at line 148 of file PowerTelemetry.h.
detect_default_power_monitor_profile()
|
Detect the most likely built-in board power profile for the current host.
Definition at line 162 of file PowerTelemetry.h.
format_power_summary()
|
Format a compact human-readable power summary.
Definition at line 217 of file PowerTelemetry.h.
modalix_dvt_power_monitor_options()
|
Convenience options enabling Modalix DVT power monitoring.
Definition at line 201 of file PowerTelemetry.h.
modalix_som_power_monitor_options()
|
Convenience options enabling Modalix SOM power monitoring.
Definition at line 194 of file PowerTelemetry.h.
power_monitor_profile_name()
|
Human-readable name for a power monitor profile.
Definition at line 169 of file PowerTelemetry.h.
power_rails_for_profile()
|
Resolve a built-in board profile to its rail table.
Definition at line 176 of file PowerTelemetry.h.
power_summary_to_json()
|
Format power summary as a JSON object.
Definition at line 223 of file PowerTelemetry.h.
read_power_snapshot()
|
Read Sentinel's latest power sample.
options is ignored. Throws std::runtime_error when Sentinel cannot be read.
- Deprecated
-
Use TelemetryMonitor.
Definition at line 211 of file PowerTelemetry.h.
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.