Table of Contents

Class MediaBlocksPipelineSnapshotResult

Namespace
VisioForge.Core.MediaBlocks.Serialization
Assembly
VisioForge.Core.dll

What VisioForge.Core.MediaBlocks.Serialization.MediaBlocksPipelineSnapshot.Capture(VisioForge.Core.MediaBlocks.MediaBlocksPipeline) produced: the document, and everything it could not read off the live pipeline.

public class MediaBlocksPipelineSnapshotResult

Inheritance

Inherited Members

Constructors

MediaBlocksPipelineSnapshotResult(MediaBlocksPipelineDocument, IReadOnlyList<MediaBlocksDiagnostic>)

Initializes a new instance of the VisioForge.Core.MediaBlocks.Serialization.MediaBlocksPipelineSnapshotResult class.

public MediaBlocksPipelineSnapshotResult(MediaBlocksPipelineDocument document, IReadOnlyList<MediaBlocksDiagnostic> diagnostics)

Parameters

document MediaBlocksPipelineDocument

The captured document.

diagnostics IReadOnlyList<MediaBlocksDiagnostic>

Everything that could not be captured.

Properties

Complete

Gets a value indicating whether the whole pipeline was captured. When false the document describes the graph but not every block's configuration, so materializing it gives a pipeline of the same shape with some blocks on their defaults.

public bool Complete { get; }

Property Value

bool

Diagnostics

Gets what could not be read off the pipeline - a block that does not expose its settings (MBS060), a block the catalog does not know (MBS061), a connection that could not be expressed (MBS062).

public IReadOnlyList<MediaBlocksDiagnostic> Diagnostics { get; }

Property Value

IReadOnlyList<MediaBlocksDiagnostic>

Document

Gets the captured document. Always present: a block that could not be captured is left out and reported, rather than stopping the snapshot.

public MediaBlocksPipelineDocument Document { get; }

Property Value

MediaBlocksPipelineDocument