Class ControlFlowNodeAdorner<TInstruction>

Namespace

Echo.ControlFlow.Serialization.Dot

Assembly

Echo.ControlFlow.dll

Represents an adorner that adds the string representation of the embedded instructions to a node in a graph.

public class ControlFlowNodeAdorner<TInstruction> : IDotNodeAdorner where TInstruction : notnull

Type Parameters

TInstruction

The type of instructions the nodes contain.

Inheritance

object

ControlFlowNodeAdorner<TInstruction>

Implements

IDotNodeAdorner

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ControlFlowNodeAdorner()

Creates a new ControlFlowNodeAdorner<TInstruction> with the default formatter.

public ControlFlowNodeAdorner()

ControlFlowNodeAdorner(IInstructionFormatter<TInstruction>)

Creates a new ControlFlowNodeAdorner<TInstruction> with the specified IInstructionFormatter<TInstruction>.

public ControlFlowNodeAdorner(IInstructionFormatter<TInstruction> formatter)

Parameters

formatter IInstructionFormatter<TInstruction>

The IInstructionFormatter<TInstruction> to format instructions with.

Properties

BlockHeaderFormat

Gets or sets a value indicating the format of block headers. This is a format string with one parameter containing the value of Offset.

public string BlockHeaderFormat { get; set; }

Property Value

string

IncludeBlockHeaders

Gets or sets a value indicating whether the adorner should add block headers to every node.

public bool IncludeBlockHeaders { get; set; }

Property Value

bool

IncludeInstructions

Gets or sets a value indicating whether the adorner should add the block instructions to every node.

public bool IncludeInstructions { get; set; }

Property Value

bool

InstructionFormatter

Gets or sets the formatter that will be used to format the instructions.

public IInstructionFormatter<TInstruction> InstructionFormatter { get; set; }

Property Value

IInstructionFormatter<TInstruction>

NodeShape

Gets or sets the shape of the node.

public string NodeShape { get; set; }

Property Value

string

Methods

GetNodeAttributes(INode, long)

Obtains the adornments that should be added to the node.

public IDictionary<string, string>? GetNodeAttributes(INode node, long id)

Parameters

node INode

The node to adorn.

id long

The identifier assigned to the node.

Returns

IDictionary<string, string>

The adornments.