Skip to main content

RunReportOptions Struct

Toggles for what Run::report() includes in its formatted text output. More...

Declaration

struct simaai::neat::RunReportOptions { ... }

Included Headers

#include <Run.h>

Public Member Attributes Index

boolinclude_pipeline = true

Include the rendered pipeline launch string. More...

boolinclude_stage_timings = true

Include the per-stage timing table. More...

boolinclude_element_timings = true

Include the per-element timing table. More...

boolinclude_boundaries = true

Include per-boundary flow stats between Nodes. More...

boolinclude_flow_stats = true

Include per-element buffer/byte flow stats. More...

boolinclude_node_reports = false

Off by default — verbose. More...

boolinclude_next_cpu = false

Off by default — internal routing detail. More...

boolinclude_queue_depth = true

Include configured queue depth in the report header. More...

boolinclude_num_buffers = true

Include configured num-buffers in the report header. More...

boolinclude_run_stats = true

Include end-to-end RunStats. More...

boolinclude_input_stats = true

Include input-side stream stats. More...

boolinclude_power = true

Include power telemetry when the Run enabled it. More...

boolinclude_system_info = false

Off by default — system-wide info, not Run-specific. More...

Description

Toggles for what Run::report() includes in its formatted text output.

Each field corresponds to one section of the human-readable report. Defaults produce a useful general-purpose report; toggle off to focus on a specific subsystem.

Definition at line 470 of file Run.h.

Public Member Attributes

include_boundaries

bool simaai::neat::RunReportOptions::include_boundaries = true

Include per-boundary flow stats between Nodes.

Definition at line 474 of file Run.h.

474 bool include_boundaries = true;

include_element_timings

bool simaai::neat::RunReportOptions::include_element_timings = true

Include the per-element timing table.

Definition at line 473 of file Run.h.

473 bool include_element_timings = true;

include_flow_stats

bool simaai::neat::RunReportOptions::include_flow_stats = true

Include per-element buffer/byte flow stats.

Definition at line 475 of file Run.h.

475 bool include_flow_stats = true;

include_input_stats

bool simaai::neat::RunReportOptions::include_input_stats = true

Include input-side stream stats.

Definition at line 481 of file Run.h.

481 bool include_input_stats = true;

include_next_cpu

bool simaai::neat::RunReportOptions::include_next_cpu = false

Off by default — internal routing detail.

Definition at line 477 of file Run.h.

477 bool include_next_cpu = false;

include_node_reports

bool simaai::neat::RunReportOptions::include_node_reports = false

Off by default — verbose.

Definition at line 476 of file Run.h.

476 bool include_node_reports = false;

include_num_buffers

bool simaai::neat::RunReportOptions::include_num_buffers = true

Include configured num-buffers in the report header.

Definition at line 479 of file Run.h.

479 bool include_num_buffers = true;

include_pipeline

bool simaai::neat::RunReportOptions::include_pipeline = true

Include the rendered pipeline launch string.

Definition at line 471 of file Run.h.

471 bool include_pipeline = true;

include_power

bool simaai::neat::RunReportOptions::include_power = true

Include power telemetry when the Run enabled it.

Definition at line 482 of file Run.h.

482 bool include_power = true;

include_queue_depth

bool simaai::neat::RunReportOptions::include_queue_depth = true

Include configured queue depth in the report header.

Definition at line 478 of file Run.h.

478 bool include_queue_depth = true;

include_run_stats

bool simaai::neat::RunReportOptions::include_run_stats = true

Include end-to-end RunStats.

Definition at line 480 of file Run.h.

480 bool include_run_stats = true;

include_stage_timings

bool simaai::neat::RunReportOptions::include_stage_timings = true

Include the per-stage timing table.

Definition at line 472 of file Run.h.

472 bool include_stage_timings = true;

include_system_info

bool simaai::neat::RunReportOptions::include_system_info = false

Off by default — system-wide info, not Run-specific.

Definition at line 483 of file Run.h.

483 bool include_system_info = false;

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


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.