SessionReport Struct

Structured pipeline diagnostics — the framework's primary triage record. More...

Declaration

struct simaai::neat::SessionReport { ... }

Included Headers

#include <SessionReport.h>

Public Member Functions Index

std::string	to_json () const
	Serialize the entire report to JSON for CI bundling, support tickets, or persistent triage. More...

Public Member Attributes Index

std::string	pipeline_string
	The GStreamer launch string the framework produced. More...
std::string	error_code
	Canonical machine-triage code (see pipeline/ErrorCodes.h). More...
std::vector< NodeReport >	nodes
	Per-Node entries: what each Node emitted. More...
std::vector< BusMessage >	bus
	Captured GStreamer bus messages. More...
std::vector< BoundaryFlowStats >	boundaries
	Per-boundary flow stats (if probes were inserted). More...
std::string	caps_dump
	Verbose caps dump (populated on caps negotiation failures). More...
std::vector< std::string >	dot_paths
	Paths to GraphViz .dot files dumped for visualization. More...
std::string	repro_gst_launch
	Standalone ‘gst-launch-1.0 -v `...'` command that reproduces the pipeline. More...
std::string	repro_env
	Suggested env vars for reproduction (GST_DEBUG, DOT dir, etc.). More...
std::string	repro_note
	Human-readable summary + actionable hint. More...
bool	has_build_adaptation = false
	True when build_adaptation is meaningful (only for build(input) flows). More...
BuildAdaptationSummary	build_adaptation
	Build-time caps adaptation snapshot. More...

Description

Structured pipeline diagnostics — the framework's primary triage record.

Returned by Session::validate() (always) and carried by SessionError::report() (when thrown). On success, contains the pipeline string and any informational diagnostics; on failure, also contains error_code, captured bus messages, optional caps dumps, and a standalone reproducer command.

Triage workflow: read error_code first (machine-bucketable), then repro_note (human summary), then bus[] for first terminal errors, then repro_gst_launch to replay outside the framework.

See Also

SessionError, ValidateOptions, "Error code taxonomy" (§41)

Definition at line 141 of file SessionReport.h.

Public Member Functions

to_json()

std::string simaai::neat::SessionReport::to_json ()

Serialize the entire report to JSON for CI bundling, support tickets, or persistent triage.

Definition at line 170 of file SessionReport.h.

Public Member Attributes

boundaries

std::vector<BoundaryFlowStats> simaai::neat::SessionReport::boundaries

Per-boundary flow stats (if probes were inserted).

Definition at line 153 of file SessionReport.h.

153 std::vector<BoundaryFlowStats> boundaries;

build_adaptation

BuildAdaptationSummary simaai::neat::SessionReport::build_adaptation

Build-time caps adaptation snapshot.

Definition at line 167 of file SessionReport.h.

167 BuildAdaptationSummary build_adaptation;

bus

std::vector<BusMessage> simaai::neat::SessionReport::bus

Captured GStreamer bus messages.

Definition at line 152 of file SessionReport.h.

152 std::vector<BusMessage> bus;

caps_dump

std::string simaai::neat::SessionReport::caps_dump

Verbose caps dump (populated on caps negotiation failures).

Definition at line 156 of file SessionReport.h.

156 std::string caps_dump;

dot_paths

std::vector<std::string> simaai::neat::SessionReport::dot_paths

Paths to GraphViz .dot files dumped for visualization.

Definition at line 157 of file SessionReport.h.

157 std::vector<std::string> dot_paths;

error_code

std::string simaai::neat::SessionReport::error_code

Canonical machine-triage code (see pipeline/ErrorCodes.h).

Empty when the operation succeeded or only informational diagnostics are returned. Otherwise, one of the domain.reason constants from simaai::neat::error_codes.

Definition at line 149 of file SessionReport.h.

149 std::string error_code;

has_build_adaptation

bool simaai::neat::SessionReport::has_build_adaptation = false

True when build_adaptation is meaningful (only for build(input) flows).

Definition at line 166 of file SessionReport.h.

166 bool has_build_adaptation = false;

nodes

std::vector<NodeReport> simaai::neat::SessionReport::nodes

Per-Node entries: what each Node emitted.

Definition at line 151 of file SessionReport.h.

151 std::vector<NodeReport> nodes;

pipeline_string

std::string simaai::neat::SessionReport::pipeline_string

The GStreamer launch string the framework produced.

Definition at line 142 of file SessionReport.h.

142 std::string pipeline_string;

repro_env

std::string simaai::neat::SessionReport::repro_env

Suggested env vars for reproduction (GST_DEBUG, DOT dir, etc.).

Definition at line 162 of file SessionReport.h.

162 std::string repro_env;

repro_gst_launch

std::string simaai::neat::SessionReport::repro_gst_launch

Standalone ‘gst-launch-1.0 -v `...'` command that reproduces the pipeline.

Definition at line 160 of file SessionReport.h.

160 std::string repro_gst_launch;

repro_note

std::string simaai::neat::SessionReport::repro_note

Human-readable summary + actionable hint.

Definition at line 163 of file SessionReport.h.

163 std::string repro_note;

---

The documentation for this struct was generated from the following file:

• SessionReport.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.