stig-engine/com.stigway.engine.types/AnalysisDepth

AnalysisDepth

enum AnalysisDepth : Enum<AnalysisDepth>

Analysis depth: at what granularity are interface points decomposed for taint analysis.

Value	Meaning
GROUP	One source/sink per whole interface point (e.g. entire topic message).
LEAF	One source/sink per leaf field within the interface point.
BOTH	Both GROUP and LEAF sources/sinks are used.

The C++ harness convention uses different function names per depth:

GROUP: harness::SourceGroup<T>() / harness::SinkGroup<T>(ptr)
LEAF: harness::SourceLeaf<T, F>() / harness::SinkLeaf<T, F>(ptr)

Entries

GROUP

Analyze at the group (whole interface point) level.

LEAF

Analyze at the leaf (per field) level.

BOTH

Analyze at both GROUP and LEAF levels.

ANY

Depth is not known / not applicable at this stage.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<AnalysisDepth>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

folderName

fun folderName(): String

Folder-name segment used in the analyzer path scheme (per_group / per_leaf / any). Path scheme: see issue12-pipeline-cleanup.md. Calling this on BOTH is an error — orchestration must expand BOTH into the concrete GROUP+LEAF pair upstream.

valueOf

fun valueOf(value: String): AnalysisDepth

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<AnalysisDepth>

Returns an array containing the constants of this enum type, in the order they're declared.