GraphRunOptions Struct

Tuning knobs for a GraphRun — queue capacities, push/pull timeouts, verbosity. More...

Declaration

struct simaai::neat::graph::GraphRunOptions { ... }

Included Headers

#include <GraphRun.h>

Public Member Functions Index

GraphRunOptions &	enable_board_power (int sample_interval_ms=100)
	Enable one graph-level board power monitor using built-in auto-detect. More...
GraphRunOptions &	enable_modalix_som_power (int sample_interval_ms=100)
	Enable one graph-level Modalix SOM power monitor. More...
GraphRunOptions &	enable_modalix_dvt_power (int sample_interval_ms=100)
	Enable one graph-level Modalix DVT power monitor. More...
GraphRunOptions &	disable_power_monitor ()
	Disable graph-level power monitoring after it was enabled/configured. More...

Public Member Attributes Index

std::size_t	edge_queue = ...
	Bounded capacity for graph edge/stage/sink queues. 0 = unbounded. More...
int	push_timeout_ms = ...
	Max wait (ms) on push() before failing fast with a backpressure error. More...
int	pull_timeout_ms = 50
	Poll timeout (ms) for internal pop/pull loops. More...
VerboseOptions	verbose
	Verbosity for graph/session progress logs. More...
RunOptions	pipeline
	Underlying pipeline-runtime options forwarded to GStreamer-side runs. More...
PowerMonitorOptions	power_monitor
	Optional graph-level board power monitor. More...

Description

Tuning knobs for a GraphRun — queue capacities, push/pull timeouts, verbosity.

Definition at line 36 of file GraphRun.h.

Public Member Functions

disable_power_monitor()

GraphRunOptions & simaai::neat::graph::GraphRunOptions::disable_power_monitor ()

inline

Disable graph-level power monitoring after it was enabled/configured.

Definition at line 76 of file GraphRun.h.

76 GraphRunOptions& disable_power_monitor() {

77 power_monitor = PowerMonitorOptions{};

78 return *this;

79 }

enable_board_power()

GraphRunOptions & simaai::neat::graph::GraphRunOptions::enable_board_power (int sample_interval_ms=100)

inline

Enable one graph-level board power monitor using built-in auto-detect.

This is the preferred API for graph-level power because one graph can contain multiple pipeline segments and per-segment monitors would double-count board rails.

Definition at line 52 of file GraphRun.h.

52 GraphRunOptions& enable_board_power(int sample_interval_ms = 100) {

53 power_monitor = board_power_monitor_options(sample_interval_ms);

54 return *this;

55 }

enable_modalix_dvt_power()

GraphRunOptions & simaai::neat::graph::GraphRunOptions::enable_modalix_dvt_power (int sample_interval_ms=100)

inline

Enable one graph-level Modalix DVT power monitor.

Definition at line 70 of file GraphRun.h.

70 GraphRunOptions& enable_modalix_dvt_power(int sample_interval_ms = 100) {

71 power_monitor = modalix_dvt_power_monitor_options(sample_interval_ms);

72 return *this;

73 }

enable_modalix_som_power()

GraphRunOptions & simaai::neat::graph::GraphRunOptions::enable_modalix_som_power (int sample_interval_ms=100)

inline

Enable one graph-level Modalix SOM power monitor.

Prefer enable_board_power() unless you need to force the SOM profile.

Definition at line 62 of file GraphRun.h.

62 GraphRunOptions& enable_modalix_som_power(int sample_interval_ms = 100) {

63 power_monitor = modalix_som_power_monitor_options(sample_interval_ms);

64 return *this;

65 }

Public Member Attributes

edge_queue

std::size_t simaai::neat::graph::GraphRunOptions::edge_queue

Bounded capacity for graph edge/stage/sink queues. 0 = unbounded.

Initialiser

= 256

Definition at line 37 of file GraphRun.h.

37 std::size_t edge_queue =

pipeline

RunOptions simaai::neat::graph::GraphRunOptions::pipeline

Underlying pipeline-runtime options forwarded to GStreamer-side runs.

Definition at line 43 of file GraphRun.h.

43 RunOptions pipeline;

power_monitor

PowerMonitorOptions simaai::neat::graph::GraphRunOptions::power_monitor

Optional graph-level board power monitor.

Definition at line 44 of file GraphRun.h.

44 PowerMonitorOptions power_monitor;

pull_timeout_ms

int simaai::neat::graph::GraphRunOptions::pull_timeout_ms = 50

Poll timeout (ms) for internal pop/pull loops.

Definition at line 41 of file GraphRun.h.

41 int pull_timeout_ms = 50;

push_timeout_ms

int simaai::neat::graph::GraphRunOptions::push_timeout_ms

Max wait (ms) on push() before failing fast with a backpressure error.

Initialiser

= 5000

Definition at line 39 of file GraphRun.h.

39 int push_timeout_ms =

verbose

VerboseOptions simaai::neat::graph::GraphRunOptions::verbose

Verbosity for graph/session progress logs.

Definition at line 42 of file GraphRun.h.

42 VerboseOptions verbose;

---

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

• GraphRun.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.