BenchmarkScenario class abstract

Convenience base class for scenarios (SC-001 ergonomics).

Subclasses implement id, name, version and run; everything else has working defaults. The base performs no behavior of its own — it only removes boilerplate, keeping the contract itself implementable from scratch by plugins that prefer the pure interface (FR-015).

Inheritance

Constructors

BenchmarkScenario()
Creates a scenario base.
const

Properties

configSchema → Map<String, dynamic>
JSON Schema (subset) describing the scenario's configuration.
no setterinherited
description → String
What this benchmark measures.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
Unique, kebab-case identifier for this scenario.
no setterinherited
name → String
Human-readable name.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → List<String>
Categorization tags.
no setterinherited
thresholds → Map<String, ThresholdConfig>
Pass/fail thresholds keyed by metric name.
no setterinherited
version → String
Semantic version of the scenario.
no setterinherited

Methods

collectMetrics() → Future<Map<String, num>>
Returns custom metrics beyond the standard set, collected by the runner after run completes.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
run(Map<String, dynamic> config) → Future<BenchmarkResult>
Executes the benchmark with the given configuration and returns a partial result carrying the scenario's own metrics. Standard metrics (latency percentiles, throughput, memory, CPU) are layered on by the runner's measurement stage.
inherited
setup() → Future<void>
Called once before benchmark execution for setup.
inherited
teardown() → Future<void>
Called after benchmark execution for cleanup.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited