Skip to content
ChartForgeX
Class

TopologyResolvedScenarioStep

ChartForgeX.Topology

Namespace
ChartForgeX.Topology
Assembly
ChartForgeX
Modifiers
sealed

One scenario step resolved to the nodes and edge it touches.

Inheritance

  • object
  • TopologyResolvedScenarioStep

Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Accepted by parameters 1

Properties

public int Index { get; } #

Gets the zero-based step index.

public TopologyScenarioStep Step { get; } #

Gets the source step.

public TopologyScenarioStepKind Kind { get; } #

Gets whether the step references a node or an edge.

public TopologyScenarioInteraction Interaction { get; } #

Gets what happens on the edge.

public string SourceNodeId { get; } #

Gets the node the step starts at, or the visited node for node steps.

public string SourceLabel { get; } #

Gets the display label of the source node.

public string? TargetNodeId { get; } #

Gets the node the step travels to, or null for node steps.

public string? TargetLabel { get; } #

Gets the display label of the target node.

public string? EdgeId { get; } #

Gets the edge the step travels over, or null for node steps.

public string Label { get; } #

Gets the step label, falling back to the edge label or the visited node label.

public bool TravelsBackward { get; } #

Gets whether the step travels its edge from the edge target to the edge source.

public string? Payload { get; } #

Gets the optional payload.

public TopologyScenarioPayloadFormat PayloadFormat { get; } #

Gets the payload format.

public bool IsFailure { get; } #

Gets whether the step is a failed call.

public IReadOnlyList<string> NodeIds { get; } #

Gets the node ids to highlight while the step is active.

public IReadOnlyList<string> EdgeIds { get; } #

Gets the edge ids to highlight while the step is active.

public string Summary { get; } #

Gets a one-line summary such as Admin → DC01: Modify user.