Class DebugExtensions

Class containing debug extensions for the executive subsystem.

Inheritance

System.Object

DebugExtensions

Namespace: Microsoft.Psi

Assembly: Microsoft.Psi.dll

Syntax

public static class DebugExtensions : object

Methods

DebugView<T>(IProducer<T>, String, DeliveryPolicy<T>)

Publishes the specified stream to the debug partition, allowing debugging visualizers to display the data.

Declaration

public static string DebugView<T>(this IProducer<T> source, string name = null, DeliveryPolicy<T> deliveryPolicy = null)

Parameters

Type	Name	Description
IProducer<T>	source	The stream to visualize.
System.String	name	The name to use when visualizing the stream.
DeliveryPolicy<T>	deliveryPolicy	An optional delivery policy.

Returns

Type	Description
System.String	The debug name of the stream, either as provided or the generated one if one was not specified.

Type Parameters

Name	Description
T	The type of data in the stream.

DisableDebugViews()

Call this to disable DebugView calls. Usually wrapped in #ifdef DEBUG conditional statements.

Declaration

public static void DisableDebugViews()

DumpStructure(Pipeline, String)

Generates a .dgml file that can be opened in Visual Studio to visualize the pipeline structure. See https://msdn.microsoft.com/en-us/library/ee842619.aspx.

Declaration

public static void DumpStructure(this Pipeline pipeline, string fileName)

Parameters

Type	Name	Description
Pipeline	pipeline	The pipeline to dump.
System.String	fileName	The name (and path) of the new file to generate.

EnableDebugViews()

Call this to enable DebugView calls. Usually wrapped in #ifdef DEBUG conditional statements.

Declaration

public static void EnableDebugViews()