SimaaiGstErrorContext Struct

Bag of diagnostic fields used to build SiMa GStreamer error/warning messages. More...

Declaration

struct SimaaiGstErrorContext { ... }

Included Headers

#include <SimaaiGstErrors.h>

Public Member Attributes Index

const char *	plugin = nullptr
	Owning plugin name, e.g., "simaai-process-mla". More...
const char *	node = nullptr
	Logical node identifier within the pipeline. More...
const char *	config_path = nullptr
	Path to the plugin's config JSON, if any. More...
const char *	model_path = nullptr
	Path to the model artifact, if any. More...
int	graph_id = -1
	Graph identifier; -1 if unset. More...
std::int64_t	frame_id = -1
	Frame counter where the error occurred; -1 if unset. More...
const char *	stream_id = nullptr
	GStreamer stream id. More...
const char *	input_caps = nullptr
	Input pad caps as a string. More...
const char *	output_caps = nullptr
	Output pad caps as a string. More...
const char *	input_dims = nullptr
	Input tensor dims summary. More...
const char *	output_dims = nullptr
	Output tensor dims summary. More...
const char *	allocator = nullptr
	Allocator name in use. More...
const char *	dispatcher_err = nullptr
	Dispatcher-layer error string, if any. More...
const char *	hint = nullptr
	Free-form actionable hint for the user. More...
const char *	stage_key = nullptr
	Stage key that failed. More...
const char *	source_used = nullptr
	Origin of the config decision (e.g., "framework"). More...
const char *	missing_field = ...
	Missing required field name, if a config-validation failure. More...
const char *	fallback_chain = nullptr
	Comma-separated fallback chain that was tried. More...

Description

Bag of diagnostic fields used to build SiMa GStreamer error/warning messages.

Every field is optional; formatters skip null/empty values. Integer fields use -1 as their "unset" sentinel and are skipped when negative. Populate as many fields as the plugin has on hand at the failure site — more context means easier triage.

Definition at line 34 of file SimaaiGstErrors.h.

Public Member Attributes

allocator

const char* SimaaiGstErrorContext::allocator = nullptr

Allocator name in use.

Definition at line 46 of file SimaaiGstErrors.h.

config_path

const char* SimaaiGstErrorContext::config_path = nullptr

Path to the plugin's config JSON, if any.

Definition at line 37 of file SimaaiGstErrors.h.

dispatcher_err

const char* SimaaiGstErrorContext::dispatcher_err = nullptr

Dispatcher-layer error string, if any.

Definition at line 47 of file SimaaiGstErrors.h.

fallback_chain

const char* SimaaiGstErrorContext::fallback_chain = nullptr

Comma-separated fallback chain that was tried.

Definition at line 53 of file SimaaiGstErrors.h.

frame_id

std::int64_t SimaaiGstErrorContext::frame_id = -1

Frame counter where the error occurred; -1 if unset.

Definition at line 40 of file SimaaiGstErrors.h.

graph_id

int SimaaiGstErrorContext::graph_id = -1

Graph identifier; -1 if unset.

Definition at line 39 of file SimaaiGstErrors.h.

hint

const char* SimaaiGstErrorContext::hint = nullptr

Free-form actionable hint for the user.

Definition at line 48 of file SimaaiGstErrors.h.

input_caps

const char* SimaaiGstErrorContext::input_caps = nullptr

Input pad caps as a string.

Definition at line 42 of file SimaaiGstErrors.h.

input_dims

const char* SimaaiGstErrorContext::input_dims = nullptr

Input tensor dims summary.

Definition at line 44 of file SimaaiGstErrors.h.

missing_field

const char* SimaaiGstErrorContext::missing_field

Missing required field name, if a config-validation failure.

Initialiser

= nullptr

Definition at line 51 of file SimaaiGstErrors.h.

model_path

const char* SimaaiGstErrorContext::model_path = nullptr

Path to the model artifact, if any.

Definition at line 38 of file SimaaiGstErrors.h.

node

const char* SimaaiGstErrorContext::node = nullptr

Logical node identifier within the pipeline.

Definition at line 36 of file SimaaiGstErrors.h.

output_caps

const char* SimaaiGstErrorContext::output_caps = nullptr

Output pad caps as a string.

Definition at line 43 of file SimaaiGstErrors.h.

output_dims

const char* SimaaiGstErrorContext::output_dims = nullptr

Output tensor dims summary.

Definition at line 45 of file SimaaiGstErrors.h.

plugin

const char* SimaaiGstErrorContext::plugin = nullptr

Owning plugin name, e.g., "simaai-process-mla".

Definition at line 35 of file SimaaiGstErrors.h.

source_used

const char* SimaaiGstErrorContext::source_used = nullptr

Origin of the config decision (e.g., "framework").

Definition at line 50 of file SimaaiGstErrors.h.

stage_key

const char* SimaaiGstErrorContext::stage_key = nullptr

Stage key that failed.

Definition at line 49 of file SimaaiGstErrors.h.

stream_id

const char* SimaaiGstErrorContext::stream_id = nullptr

GStreamer stream id.

Definition at line 41 of file SimaaiGstErrors.h.

---

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

• SimaaiGstErrors.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.