Class ComponentRunResults

Namespace: Phoenix.ComponentAPI
Assembly: Phoenix.ComponentAPI.dll

An almost immutable class that contains the results of a run evaluation.

public class ComponentRunResults : AbstractDisposable, IDisposable

Inheritance

object ← AbstractDisposable ← ComponentRunResults

Implements

IDisposable

Inherited Members

AbstractDisposable.disposed, AbstractDisposable.Dispose(), AbstractDisposable.IsDisposed, AbstractDisposable.Dispose(bool), object.Equals(object), object.Equals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object, object), object.ToString()

Remarks

This class may contain FileValue instances that own temp files on disk. All uses of this class should be used in a using block, or otherwise reliably disposed.

The exception to immutability is Phoenix.ComponentAPI.ComponentRunResults.MoveResultsTo(Phoenix.ModelCenter.Common.Types.VariableValueScope)

Properties

ResultMetadata

Metadata about each run.

ResultValues

The output variable values.

Methods

CreateCanceled()

Creates a new ComponentRunResults in the Canceled state.

CreateCloneFrom(IReadOnlyDictionary<string, VariableState>, ComponentRunResultsMetadata)

Creates a new ComponentRunResults by making a clone of the given data.

Dispose(bool)

Standard disposal.

MoveResultsTo(VariableValueScope)

Puts the results from this object into the passed in scope. This object will show zero results after calling this function.

MoveStateFrom(IEnumerable<KeyValuePair<string, VariableState>>, ComponentRunResultsMetadata)

Creates a new instance of a ComponentRunResults.

MoveStateFrom(VariableValueScope, ComponentRunResultsMetadata)

Creates a new instance of a ComponentRunResults by moving the data.